API Test Keys

Payouts to Cards Entity

The Payouts to Cards Entity has the following parameters:

Is this page helpful?

Sample Entity

1{
2  "id": "pout_00000000000001",
3  "entity": "payout",
4  "fund_account_id": "fa_00000000000001",
5  "fund_account": {
6    "id": "fa_00000000000001",
7    "entity": "fund_account",
8    "contact_id": "cont_00000000000001",
9    "contact": {
10      "id": "cont_00000000000001",
11      "entity": "contact",
12      "contact": "9876543210",
13      "email": "gaurav.kumar@example.com",
14      "type": "employee",
15      "reference_id": "Acme Contact ID 12345",
16      "batch_id": null,
17      "active": true,
18      "notes": {
19        "notes_key_1": "Tea, Earl Grey, Hot",
20        "notes_key_2": "Tea, Earl Grey… decaf."
21      },
22      "created_at": 1580817353
23    },
24    "account_type": "card",
25    "card": {
26      "last4": "6789",
27      "network": "Visa",
28      "type": "credit",
29      "issuer": "HDFC",
30      "input_type": "card"
31    },
32    "batch_id": null,
33    "active": true,
34    "created_at": 1581080272
35  },
36  "amount": 1000000,
37  "currency": "INR",
38  "notes": {
39    "notes_key_1": "Beam me up Scotty",
40    "notes_key_2": "Engage"
41  },
42  "fees": 590,
43  "tax": 90,
44  "status": "processed",
45  "purpose": "payout",
46  "utr": null,
47  "mode": "NEFT",
48  "reference_id": "Acme Transaction ID 12345",
49  "narration": "Acme Corp Fund Transfer",
50  "batch_id": null,
51  "failure_reason": null,
52  "created_at": 1581499319,
53  "fee_type": "",
54  "error": {
55    "description": null,
56    "source": null,
57    "reason": null
58  }
59}

id

string

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

entity

string

The entity being created. For example, payout.

fund_account_id

string

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

fund_account

object

The account to which you want to make the payout.

Show child parameters (5)

amount

integer

The payout amount, in paise. For example, if you want to transfer ₹10,000, pass 1000000. Minimum value 100.

The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.

currency

string

The payout currency. Here, it is INR.

notes

array of objects

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. 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 status of the payout. Possible payout states:

queued
pending (if you have
Approval Workflow
enabled)
rejected (if you have
Approval Workflow
enabled)
processing
processed
cancelled
reversed

purpose

string

The purpose of the payout that is being created. The following classifications are available in the system 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. Available modes:

NEFT
RTGS
IMPS
UPI
card

The payout modes are case-sensitive.

reference_id

string

Maximum length is 40 characters. A user-generated reference given to the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration

string

Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. 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.

Enter the important text in the first 9 characters as banks truncate the rest as per their standards.

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, when the contact was created. For example, 1545320320.

fee_type

string

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

Payouts to Cards Entity

The Payouts to Cards 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. For example, payout.

fund_account_id

string

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

fund_account

object

The account to which you want to make the payout.

Show child parameters (5)

amount

integer

currency

string

The payout currency. Here, it is INR.

notes

array of objects

Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. 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 status of the payout. Possible payout states:

queued
pending (if you have
Approval Workflow
enabled)
rejected (if you have
Approval Workflow
enabled)
processing
processed
cancelled
reversed

purpose

string

The purpose of the payout that is being created. The following classifications are available in the system 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. Available modes:

NEFT
RTGS
IMPS
UPI
card

The payout modes are case-sensitive.

reference_id

string

Maximum length is 40 characters. A user-generated reference given to the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

narration

string

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, when the contact 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_00000000000001",
3  "entity": "payout",
4  "fund_account_id": "fa_00000000000001",
5  "fund_account": {
6    "id": "fa_00000000000001",
7    "entity": "fund_account",
8    "contact_id": "cont_00000000000001",
9    "contact": {
10      "id": "cont_00000000000001",
11      "entity": "contact",
12      "contact": "9876543210",
13      "email": "gaurav.kumar@example.com",
14      "type": "employee",
15      "reference_id": "Acme Contact ID 12345",
16      "batch_id": null,
17      "active": true,
18      "notes": {
19        "notes_key_1": "Tea, Earl Grey, Hot",
20        "notes_key_2": "Tea, Earl Grey… decaf."
21      },
22      "created_at": 1580817353
23    },
24    "account_type": "card",
25    "card": {
26      "last4": "6789",
27      "network": "Visa",
28      "type": "credit",
29      "issuer": "HDFC",
30      "input_type": "card"
31    },
32    "batch_id": null,
33    "active": true,
34    "created_at": 1581080272
35  },
36  "amount": 1000000,
37  "currency": "INR",
38  "notes": {
39    "notes_key_1": "Beam me up Scotty",
40    "notes_key_2": "Engage"
41  },
42  "fees": 590,
43  "tax": 90,
44  "status": "processed",
45  "purpose": "payout",
46  "utr": null,
47  "mode": "NEFT",
48  "reference_id": "Acme Transaction ID 12345",
49  "narration": "Acme Corp Fund Transfer",
50  "batch_id": null,
51  "failure_reason": null,
52  "created_at": 1581499319,
53  "fee_type": "",
54  "error": {
55    "description": null,
56    "source": null,
57    "reason": null
58  }
59}