API Test Keys

Fetch All Payouts

GET

/v1/payouts?account_number=\{account number\}

Click to copy

Use this endpoint to retrieve the details of all the available payouts in the system.

To understand the status of the payouts, refer to

Payout Status Details

Watch Out!

We DO NOT recommend using the Fetch Payout API to check the status of the payouts. Instead, we recommend that you subscribe to our

Webhooks

to get instant notifications. Whenever the status of your payouts change, you will be notified via these webhooks.

Is this page helpful?

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2    -X GET https://api.razorpay.com/v1/payouts?account_number=7878780080316316

Success

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "pout_00000000000001",
7      "entity": "payout",
8      "fund_account_id": "fa_00000000000001",
9      "amount": 1000000,
10      "currency": "INR",
11      "notes": {
12        "notes_key_1": "Tea, Earl Grey, Hot",
13        "notes_key_2": "Tea, Earl Grey… decaf."
14      },
15      "fees": 590,
16      "tax": 90,
17      "status": "processed",
18      "purpose": "payout",
19      "utr": null,
20      "mode": "NEFT",
21      "reference_id": "Acme Transaction ID 12345",
22      "narration": "Acme Corp Fund Transfer",
23      "batch_id": null,
24      "status_details": {
25          "description": "Payout is processed and the money has been credited into the beneficiaries account",
26          "source": "beneficiary_bank",
27          "reason": "payout_processed"
28        }
29      "created_at": 1545382870,
30      "fee_type": "",
31    },
32    {
33      "id": "pout_00000000000002",
34      "entity": "payout",
35      "fund_account_id": "fa_00000000000002",
36      "amount": 1000000,
37      "currency": "INR",
38      "notes": {
39        "notes_key_1": "Tea, Earl Grey, Hot",
40        "notes_key_2": "Tea, Earl Grey… decaf."
41      },
42      "fees": 590,
43      "tax": 90,
44      "status": "reversed",
45      "purpose": "refund",
46      "utr": null,
47      "mode": "NEFT",
48      "reference_id": "Acme Transaction ID 123456",
49      "narration": "Acme Corp Fund Transfer",
50      "batch_id": null,
51      "status_details": {
52        "description": "The NEFT 24*7 limits for your account has been exhausted. Please retry after sometime",
53        "source": "business",
54        "reason": "amount_limit_exhausted"
55      }
56      "created_at": 1545382870,
57      "fee_type": "",
58    }
59  ]
60}

Path Parameters

account_number

string

The account from which you want to make the payout. For example, 7878780080316316.

Pass your customer identifier if you want money to be deducted from RazorpayX Lite.
Pass your Current Account number if you want money to be deducted from your Current Account.

Watch Out!

This is not your contact's bank account number. Log in to your
RazorpayX Dashboard
and go to My Account & Settings → Banking → Customer Identifier.
This value is different for Test Mode and Live Mode.

Query Parameters

contact_id

string

The unique identifier of the contact for which you want to fetch payouts. For example, cont_00000000000001.

fund_account_id

string

The unique identifier of the fund account for which you want to fetch payouts. For example, fa_00000000000001.

mode

string

The mode for which payouts are to be fetched. You can use one of the following payout modes:

NEFT
RTGS
IMPS
UPI
card
amazonpay

The payout modes are case-sensitive. Ensure payout modes are entered in upper case.

reference_id

string

Maximum length is 40 characters. The user-generated reference for which payouts are to be fetched. For example, Acme Transaction ID 12345.

status

string

The payout status. Possible payout states:

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

Know more about

Payout statuses

and

Payout Status Details

from

integer

Timestamp, in Unix, from when you want to fetch payouts.

to

integer

Timestamp, in Unix, till when you want to fetch payouts.

count

integer

Number of payouts to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with skip.

skip

integer

Numbers of payouts to be skipped. Default value is 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier of 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.

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's 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
failed

Know more about

Payout States

and

Payout Status Details

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
card

The payout modes are case-sensitive.

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

Additional purposes for payouts can be created via the

Dashboard

and then used in the API. However, it is not possible to create a new purpose for the payout via the API.

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

Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space.

If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may 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

Indicates the Unix timestamp when this payout was created.

fee_type

string

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

Fetch All Payouts

GET

/v1/payouts?account_number=\{account number\}

Click to copy

Use this endpoint to retrieve the details of all the available payouts in the system.

To understand the status of the payouts, refer to

Payout Status Details

Watch Out!

We DO NOT recommend using the Fetch Payout API to check the status of the payouts. Instead, we recommend that you subscribe to our

Webhooks

to get instant notifications. Whenever the status of your payouts change, you will be notified via these webhooks.

Is this page helpful?

Path Parameters

account_number

string

The account from which you want to make the payout. For example, 7878780080316316.

Pass your customer identifier if you want money to be deducted from RazorpayX Lite.
Pass your Current Account number if you want money to be deducted from your Current Account.

Watch Out!

This is not your contact's bank account number. Log in to your
RazorpayX Dashboard
and go to My Account & Settings → Banking → Customer Identifier.
This value is different for Test Mode and Live Mode.

Query Parameters

contact_id

string

The unique identifier of the contact for which you want to fetch payouts. For example, cont_00000000000001.

fund_account_id

string

The unique identifier of the fund account for which you want to fetch payouts. For example, fa_00000000000001.

mode

string

The mode for which payouts are to be fetched. You can use one of the following payout modes:

NEFT
RTGS
IMPS
UPI
card
amazonpay

The payout modes are case-sensitive. Ensure payout modes are entered in upper case.

reference_id

string

Maximum length is 40 characters. The user-generated reference for which payouts are to be fetched. For example, Acme Transaction ID 12345.

status

string

The payout status. Possible payout states:

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

Know more about

Payout statuses

and

Payout Status Details

from

integer

Timestamp, in Unix, from when you want to fetch payouts.

to

integer

Timestamp, in Unix, till when you want to fetch payouts.

count

integer

Number of payouts to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with skip.

skip

integer

Numbers of payouts to be skipped. Default value is 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier of 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.

amount

integer

currency

string

The payout's 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
failed

Know more about

Payout States

and

Payout Status Details

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
card

The payout modes are case-sensitive.

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

Additional purposes for payouts can be created via the

Dashboard

and then used in the API. However, it is not possible to create a new purpose for the payout via the API.

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

Indicates the Unix timestamp when this payout was created.

fee_type

string

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

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2    -X GET https://api.razorpay.com/v1/payouts?account_number=7878780080316316

Success

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "pout_00000000000001",
7      "entity": "payout",
8      "fund_account_id": "fa_00000000000001",
9      "amount": 1000000,
10      "currency": "INR",
11      "notes": {
12        "notes_key_1": "Tea, Earl Grey, Hot",
13        "notes_key_2": "Tea, Earl Grey… decaf."
14      },
15      "fees": 590,
16      "tax": 90,
17      "status": "processed",
18      "purpose": "payout",
19      "utr": null,
20      "mode": "NEFT",
21      "reference_id": "Acme Transaction ID 12345",
22      "narration": "Acme Corp Fund Transfer",
23      "batch_id": null,
24      "status_details": {
25          "description": "Payout is processed and the money has been credited into the beneficiaries account",
26          "source": "beneficiary_bank",
27          "reason": "payout_processed"
28        }
29      "created_at": 1545382870,
30      "fee_type": "",
31    },
32    {
33      "id": "pout_00000000000002",
34      "entity": "payout",
35      "fund_account_id": "fa_00000000000002",
36      "amount": 1000000,
37      "currency": "INR",
38      "notes": {
39        "notes_key_1": "Tea, Earl Grey, Hot",
40        "notes_key_2": "Tea, Earl Grey… decaf."
41      },
42      "fees": 590,
43      "tax": 90,
44      "status": "reversed",
45      "purpose": "refund",
46      "utr": null,
47      "mode": "NEFT",
48      "reference_id": "Acme Transaction ID 123456",
49      "narration": "Acme Corp Fund Transfer",
50      "batch_id": null,
51      "status_details": {
52        "description": "The NEFT 24*7 limits for your account has been exhausted. Please retry after sometime",
53        "source": "business",
54        "reason": "amount_limit_exhausted"
55      }
56      "created_at": 1545382870,
57      "fee_type": "",
58    }
59  ]
60}