API Test Keys

Transactions Entity

The Transactions Entity has the following parameters:

Is this page helpful?

Sample Entity

1{
2    "id": "txn_00000000000002",
3    "entity": "transaction",
4    "account_number": "7878780080316316",
5    "amount": 1000000,
6    "currency": "INR",
7    "credit": 0,
8    "debit": 1000000,
9    "balance": 9000000,
10    "source": {
11        // if source entity = bank_transfer, the system returns the following values.
12        "id":"bt_00000000000001",
13        "entity":"bank_transfer",
14        "payer_name":"Saurav Kumar",
15        "payer_account":"6543266545411243",
16        "payer_ifsc":"UTIB0000002",
17        "mode":"NEFT",
18        "bank_reference":"AXIR000000000001",
19        // end of source entity = bank_transfer. 
20        // start of source entity = payout (default source).
21        "id": "pout_00000000000001",
22        "entity": "payout",
23        "fund_account_id": "fa_00000000000001",
24        "amount": 1000000, 
25        "notes": {
26            "notes_key_1": "Tea, Earl Grey, Hot",
27            "notes_key_2": "Tea, Earl Grey… decaf."
28        },
29        "fees": 3,
30        "tax": 1,
31        "status": "processed",
32        "utr": "000000000001",
33        "mode": "NEFT",
34        "created_at": 1545224066,
35        "fee_type": null
36    },
37    "created_at": 1545224066
38}

id

string

The unique identifier linked to the transaction. For example, txn_00000000000001.

entity

string

The entity created. Here, it is transaction.

account_number

string

The business account from which the payout was made. For example, 7878780080316316.

amount

integer

The amount transferred, in paise. The transfer can either be a credit (when you add funds to your account) or a debit (when you make a payout).

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

currency

string

The transaction currency. Here, it is INR.

credit

integer

The amount, in paise, credited to your account. Is 0 for debit transactions (when making payouts).

debit

integer

The amount, in paise, debited to your account. Is 0 for credit transactions (when adding funds to your account).

balance

integer

The remaining amount, in paise, in your account after the debit or credit transaction.

source

object

Details of the payout made or details of the bank account from which money was added to your business account.

Show child parameters (10)

fees

integer

The fees, in paise, for the transaction. This field is populated only when the transaction moves to the processing state. For example, 5.
This value is returned only when the source entity is payout.

tax

integer

The tax, in paise, for the fee being charged. This field is populated only when the transaction moves to the processing state. For example, 1.
This value is returned only when the source entity is payout.

status

string

The status of the transaction. A transaction can be in any of the following states:

pending
queued
processing
processed
reversed
cancelled
rejected

This value is returned only when the source entity is payout.

utr

string

The unique transaction number for the transaction. For example, HDFCN00000000001.
This value is returned only when the source entity is payout.

mode

string

The payout mode. Refer to the

Supported Banks and Payout Modes section

for more details.
This value is returned only when the source entity is payout.

created_at

integer

Timestamp, in Unix, when the source entity or transaction entity was created. For example, 1545320320.

Transactions Entity

The Transactions Entity has the following parameters:

Is this page helpful?

id

string

The unique identifier linked to the transaction. For example, txn_00000000000001.

entity

string

The entity created. Here, it is transaction.

account_number

string

The business account from which the payout was made. For example, 7878780080316316.

amount

integer

currency

string

The transaction currency. Here, it is INR.

credit

integer

The amount, in paise, credited to your account. Is 0 for debit transactions (when making payouts).

debit

integer

The amount, in paise, debited to your account. Is 0 for credit transactions (when adding funds to your account).

balance

integer

The remaining amount, in paise, in your account after the debit or credit transaction.

source

object

Details of the payout made or details of the bank account from which money was added to your business account.

Show child parameters (10)

fees

integer

tax

integer

status

string

The status of the transaction. A transaction can be in any of the following states:

pending
queued
processing
processed
reversed
cancelled
rejected

This value is returned only when the source entity is payout.

utr

string

The unique transaction number for the transaction. For example, HDFCN00000000001.
This value is returned only when the source entity is payout.

mode

string

The payout mode. Refer to the

Supported Banks and Payout Modes section

for more details.
This value is returned only when the source entity is payout.

created_at

integer

Timestamp, in Unix, when the source entity or transaction entity was created. For example, 1545320320.

Sample Entity

1{
2    "id": "txn_00000000000002",
3    "entity": "transaction",
4    "account_number": "7878780080316316",
5    "amount": 1000000,
6    "currency": "INR",
7    "credit": 0,
8    "debit": 1000000,
9    "balance": 9000000,
10    "source": {
11        // if source entity = bank_transfer, the system returns the following values.
12        "id":"bt_00000000000001",
13        "entity":"bank_transfer",
14        "payer_name":"Saurav Kumar",
15        "payer_account":"6543266545411243",
16        "payer_ifsc":"UTIB0000002",
17        "mode":"NEFT",
18        "bank_reference":"AXIR000000000001",
19        // end of source entity = bank_transfer. 
20        // start of source entity = payout (default source).
21        "id": "pout_00000000000001",
22        "entity": "payout",
23        "fund_account_id": "fa_00000000000001",
24        "amount": 1000000, 
25        "notes": {
26            "notes_key_1": "Tea, Earl Grey, Hot",
27            "notes_key_2": "Tea, Earl Grey… decaf."
28        },
29        "fees": 3,
30        "tax": 1,
31        "status": "processed",
32        "utr": "000000000001",
33        "mode": "NEFT",
34        "created_at": 1545224066,
35        "fee_type": null
36    },
37    "created_at": 1545224066
38}