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

Payouts Cards

Create

Save Card

Razorpay Tokenhq

Payout

API Test Keys

Create a Payout to Card with Razorpay TokenHQ

POST
/v1/payouts

Click to copy

Use this endpoint to create a payout to fund account type card by saving the card with

Razorpay TokenHQ

.

To understand the status of the payouts, refer to

Payout Status Details

.

Watch Out!

Ensure you

allowlist IPs

and pass the

idempotency key

to make a successful payout.

Is this page helpful?

Curl

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

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": 590,
12
  "tax": 90,
13
  "status": "processed",
14
  "utr": null,
15
  "mode": "card",
16
  "purpose": "refund",
17
  "reference_id": "Acme Transaction ID 12345",
18
  "narration": "Acme Corp Fund Transfer",
19
  "batch_id": null,
20
  "failure_reason": null,
21
  "created_at": 1545383037,
22
  "fee_type": "",
23
  "error": {
24
    "description": null,
25
    "source": null,
26
    "reason": null
27
  }
28
}
Request Parameters
account_number

*

string

The account from which you want to make the payout. 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.

amount

*

integer

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

currency

*

string

The payout currency. Here, it is INR.

mode

*

string

The mode to be used to create the payout. Available modes:

  • NEFT
  • RTGS
  • IMPS
  • UPI
  • card

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.

fund_account_id

*

string

The unique identifier linked to the fund account.

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.

queue_if_low_balance
boolean

The payout is automatically queued if the account balance is low.

Response Parameters
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:

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.

Create a Payout to Card with Razorpay TokenHQ

POST
/v1/payouts

Click to copy

Use this endpoint to create a payout to fund account type card by saving the card with

Razorpay TokenHQ

.

To understand the status of the payouts, refer to

Payout Status Details

.

Watch Out!

Ensure you

allowlist IPs

and pass the

idempotency key

to make a successful payout.

Is this page helpful?

Request Parameters
account_number

*

string

The account from which you want to make the payout. 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.

amount

*

integer

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

currency

*

string

The payout currency. Here, it is INR.

mode

*

string

The mode to be used to create the payout. Available modes:

  • NEFT
  • RTGS
  • IMPS
  • UPI
  • card

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.

fund_account_id

*

string

The unique identifier linked to the fund account.

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.

queue_if_low_balance
boolean

The payout is automatically queued if the account balance is low.

Response Parameters
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:

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.

Curl

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

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": 590,
12
  "tax": 90,
13
  "status": "processed",
14
  "utr": null,
15
  "mode": "card",
16
  "purpose": "refund",
17
  "reference_id": "Acme Transaction ID 12345",
18
  "narration": "Acme Corp Fund Transfer",
19
  "batch_id": null,
20
  "failure_reason": null,
21
  "created_at": 1545383037,
22
  "fee_type": "",
23
  "error": {
24
    "description": null,
25
    "source": null,
26
    "reason": null
27
  }
28
}