Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

X

Payout Composite

Entity

API Test Keys

Payout Composite Entity

The Payout Composite Entity has the following parameters:

Is this page helpful?

Sample Entity

1
{
2
    "id": "pout_F681qslJ3ba70q",
3
    "entity": "payout",
4
    "fund_account_id": "fa_F681qr6Bqy1Je7",
5
    "fund_account": {
6
        "id": "fa_F681qr6Bqy1Je7",
7
        "entity": "fund_account",
8
        "contact_id": "cont_F681qmU11CfPDl",
9
        "contact": {
10
            "id": "cont_F681qmU11CfPDl",
11
            "entity": "contact",
12
            "name": "Gaurav Kumar",
13
            "contact": "9876543210",
14
            "email": "gaurav.kumar@example.com",
15
            "type": "employee",
16
            "reference_id": "Acme Contact ID 12345",
17
            "batch_id": null,
18
            "active": true,
19
            "notes": {
20
                "notes_key_1": "Tea, Earl Grey, Hot",
21
                "notes_key_2": "Tea, Earl Grey… decaf."
22
            },
23
            "created_at": 1592929016
24
        },
25
        "account_type": "bank_account",
26
        "bank_account": {
27
            "ifsc": "HDFC0001234",
28
            "bank_name": "HDFC Bank",
29
            "name": "Gaurav Kumar",
30
            "notes": [],
31
            "account_number": "1121431121541121"
32
        },
33
        "batch_id": null,
34
        "active": true,
35
        "created_at": 1592929016
36
    },
37
    "amount": 1000000,
38
    "currency": "INR",
39
    "notes": {
40
        "notes_key_1": "Beam me up Scotty",
41
        "notes_key_2": "Engage"
42
    },
43
    "fees": 590,
44
    "tax": 90,
45
    "status": "processed",
46
    "purpose": "refund",
47
    "utr": null,
48
    "mode": "NEFT",
49
    "reference_id": "Acme Transaction ID 12345",
50
    "narration": "Acme Corp Fund Transfer",
51
    "batch_id": null,
52
    "status_details": null,
53
    "created_at": 1592929017,
54
    "fee_type": "",
55
    "error": {
56
        "description": null,
57
        "source": null,
58
        "reason": null
59
    }
60
}
id
string

The unique identifier linked to the payout. For example, pout_00000000000001.

entity
string

The entity being created. Here, it will be payout.

fund_account_id
string

The unique identifier linked to the fund account. For example, fa_00000000000001.

fund_account
object

Contact and fund account details to which the payout was made.

Show child parameters (8)

amount
integer

Minimum value 100. The payout amount, in paise. For example, if you want to transfer ₹10,000, pass 1000000.
The value passed here does not include fees and tax. Fee and tax, if any, is deducted from your account balance.

currency
string

The payout currency. Here, it is INR.

notes
object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”.

fees
integer

The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.

tax
integer

The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the processing state. For example, 1.

status
string

The payout status. Possible payout states:

purpose
string

The purpose of the payout. Classifications available by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

utr
string

The unique transaction number linked to a payout. For example, HDFCN00000000001.

mode
string

The mode used to make the payout. Refer to the

Payouts section

for more details. Available modes:
  • NEFT
  • RTGS
  • IMPS
  • UPI
  • card

reference_id
string

A reference you entered for the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration
string

This is a custom note that also appears on the bank statement.

If no value is passed for this parameter, it defaults to the Merchant Billing Label.

batch_id
string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

status_details
object

This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

Show child parameters (3)

created_at
integer

Timestamp, in Unix, at which the payout was created. For example, 1545320320.

fee_type
string

Indicates the fee type charged for the payout. Possible value is free_payout.

Payout Composite Entity

The Payout Composite Entity has the following parameters:

Is this page helpful?

id
string

The unique identifier linked to the payout. For example, pout_00000000000001.

entity
string

The entity being created. Here, it will be payout.

fund_account_id
string

The unique identifier linked to the fund account. For example, fa_00000000000001.

fund_account
object

Contact and fund account details to which the payout was made.

Show child parameters (8)

amount
integer

Minimum value 100. The payout amount, in paise. For example, if you want to transfer ₹10,000, pass 1000000.
The value passed here does not include fees and tax. Fee and tax, if any, is deducted from your account balance.

currency
string

The payout currency. Here, it is INR.

notes
object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”.

fees
integer

The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.

tax
integer

The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the processing state. For example, 1.

status
string

The payout status. Possible payout states:

purpose
string

The purpose of the payout. Classifications available by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

utr
string

The unique transaction number linked to a payout. For example, HDFCN00000000001.

mode
string

The mode used to make the payout. Refer to the

Payouts section

for more details. Available modes:
  • NEFT
  • RTGS
  • IMPS
  • UPI
  • card

reference_id
string

A reference you entered for the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration
string

This is a custom note that also appears on the bank statement.

If no value is passed for this parameter, it defaults to the Merchant Billing Label.

batch_id
string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

status_details
object

This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

Show child parameters (3)

created_at
integer

Timestamp, in Unix, at which the payout was created. For example, 1545320320.

fee_type
string

Indicates the fee type charged for the payout. Possible value is free_payout.

Sample Entity

1
{
2
    "id": "pout_F681qslJ3ba70q",
3
    "entity": "payout",
4
    "fund_account_id": "fa_F681qr6Bqy1Je7",
5
    "fund_account": {
6
        "id": "fa_F681qr6Bqy1Je7",
7
        "entity": "fund_account",
8
        "contact_id": "cont_F681qmU11CfPDl",
9
        "contact": {
10
            "id": "cont_F681qmU11CfPDl",
11
            "entity": "contact",
12
            "name": "Gaurav Kumar",
13
            "contact": "9876543210",
14
            "email": "gaurav.kumar@example.com",
15
            "type": "employee",
16
            "reference_id": "Acme Contact ID 12345",
17
            "batch_id": null,
18
            "active": true,
19
            "notes": {
20
                "notes_key_1": "Tea, Earl Grey, Hot",
21
                "notes_key_2": "Tea, Earl Grey… decaf."
22
            },
23
            "created_at": 1592929016
24
        },
25
        "account_type": "bank_account",
26
        "bank_account": {
27
            "ifsc": "HDFC0001234",
28
            "bank_name": "HDFC Bank",
29
            "name": "Gaurav Kumar",
30
            "notes": [],
31
            "account_number": "1121431121541121"
32
        },
33
        "batch_id": null,
34
        "active": true,
35
        "created_at": 1592929016
36
    },
37
    "amount": 1000000,
38
    "currency": "INR",
39
    "notes": {
40
        "notes_key_1": "Beam me up Scotty",
41
        "notes_key_2": "Engage"
42
    },
43
    "fees": 590,
44
    "tax": 90,
45
    "status": "processed",
46
    "purpose": "refund",
47
    "utr": null,
48
    "mode": "NEFT",
49
    "reference_id": "Acme Transaction ID 12345",
50
    "narration": "Acme Corp Fund Transfer",
51
    "batch_id": null,
52
    "status_details": null,
53
    "created_at": 1592929017,
54
    "fee_type": "",
55
    "error": {
56
        "description": null,
57
        "source": null,
58
        "reason": null
59
    }
60
}