Create a Payout to Amazon Pay Wallet

POST

/v1/payouts

Click to copy

Use this endpoint to create a payout to a wallet. You cannot enter a custom narration when creating a payout via Amazon Pay. Know more about

RazorpayX Payout API

Is this page helpful?

Curl

1curl -u <YOUR_KEY>:<YOUR_SECRET> \
2-X POST https://api.razorpay.com/v1/payouts \
3-H "Content-Type: application/json" \
4-d '{
5  "account_number": "7878780080316316",
6  "fund_account_id": "fa_00000000000001",
7  "amount": 1000000,
8  "currency": "INR",
9  "mode": "amazonpay",
10  "purpose": "refund",
11  "queue_if_low_balance": true,
12  "reference_id": "Acme Transaction ID 12345",
13  "notes": {
14    "notes_key_1":"Tea, Earl Grey, Hot",
15    "notes_key_2":"Tea, Earl Grey… decaf."
16  }
17}'

Success

1{
2  "id": "pout_00000000000001",
3  "entity": "payout",
4  "fund_account_id": "fa_00000000000001",
5  "amount": 1000000,
6  "currency": "INR",
7  "notes": {
8    "notes_key_1":"Tea, Earl Grey, Hot",
9    "notes_key_2":"Tea, Earl Grey… decaf."
10  },
11  "fees": 0,
12  "tax": 0,
13  "status": "queued",
14  "utr": "GCID1234567",
15  "mode": "amazonpay",
16  "purpose": "refund",
17  "reference_id": "Acme Transaction ID 12345",
18  "narration": "Acme Corp Fund Transfer",
19  "batch_id": null,
20  "status_details": null,
21  "created_at": 1545383037
22}

Request Parameters

account_number

string

Your customer identifier.
Account details can be found on the

RazorpayX Dashboard

. For example, 7878780080316316.

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.

fund_account_id

string

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

amount

integer

The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value 100 (₹1). Maximum value 1000000 (₹10,000).

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.

mode

string

The mode to be used to create the payout. Here it has to be amazonpay.

Payout modes are case-sensitive. Ensure the payout mode is entered in upper case.

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.

queue_if_low_balance

boolean

Possible values:

true: The payout is queued when your business account does not have sufficient balance to process the payout.
false (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout.

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.

notes

object

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”.

Response Parameters

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.

amount

integer

The payout amount, in paise.
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

object

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 field is populated 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 field is populated 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

Refer to

Payout Life Cycle

utr

string

Here, it will be the Amazon Pay gift card ID. For example, GCID1234567.

mode

string

The mode used to make the payout. Here it will be amazonpay. 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

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

Defaults to the Merchant Billing Label. You cannot enter a custom narration when creating a payout via Amazon Pay. Contact RazorpayX support for more information.

batch_id

string

This parameter is populated 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.

Create a Payout to Amazon Pay Wallet

POST

/v1/payouts

Click to copy

Use this endpoint to create a payout to a wallet. You cannot enter a custom narration when creating a payout via Amazon Pay. Know more about

RazorpayX Payout API

Is this page helpful?

Request Parameters

account_number

string

Your customer identifier.
Account details can be found on the

RazorpayX Dashboard

. For example, 7878780080316316.

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.

fund_account_id

string

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

amount

integer

currency

string

The payout currency. Here, it is INR.

mode

string

The mode to be used to create the payout. Here it has to be amazonpay.

Payout modes are case-sensitive. Ensure the payout mode is entered in upper case.

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.

queue_if_low_balance

boolean

Possible values:

true: The payout is queued when your business account does not have sufficient balance to process the payout.
false (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout.

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.

notes

object

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”.

Response Parameters

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.

amount

integer

The payout amount, in paise.
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

object

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 field is populated 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 field is populated 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

Refer to

Payout Life Cycle

utr

string

Here, it will be the Amazon Pay gift card ID. For example, GCID1234567.

mode

string

The mode used to make the payout. Here it will be amazonpay. 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

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

Defaults to the Merchant Billing Label. You cannot enter a custom narration when creating a payout via Amazon Pay. Contact RazorpayX support for more information.

batch_id

string

This parameter is populated 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.

Curl

1curl -u <YOUR_KEY>:<YOUR_SECRET> \
2-X POST https://api.razorpay.com/v1/payouts \
3-H "Content-Type: application/json" \
4-d '{
5  "account_number": "7878780080316316",
6  "fund_account_id": "fa_00000000000001",
7  "amount": 1000000,
8  "currency": "INR",
9  "mode": "amazonpay",
10  "purpose": "refund",
11  "queue_if_low_balance": true,
12  "reference_id": "Acme Transaction ID 12345",
13  "notes": {
14    "notes_key_1":"Tea, Earl Grey, Hot",
15    "notes_key_2":"Tea, Earl Grey… decaf."
16  }
17}'

Success

1{
2  "id": "pout_00000000000001",
3  "entity": "payout",
4  "fund_account_id": "fa_00000000000001",
5  "amount": 1000000,
6  "currency": "INR",
7  "notes": {
8    "notes_key_1":"Tea, Earl Grey, Hot",
9    "notes_key_2":"Tea, Earl Grey… decaf."
10  },
11  "fees": 0,
12  "tax": 0,
13  "status": "queued",
14  "utr": "GCID1234567",
15  "mode": "amazonpay",
16  "purpose": "refund",
17  "reference_id": "Acme Transaction ID 12345",
18  "narration": "Acme Corp Fund Transfer",
19  "batch_id": null,
20  "status_details": null,
21  "created_at": 1545383037
22}