Create a Payout to Card Using Composite API

curl -u <YOUR_KEY>:<YOUR_SECRET> \
-X POST https://api.razorpay.com/v1/payouts \
-H "Content-Type: application/json" \
-H "X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4" \
-d '{
  "account_number": "7878780080316316",
  "amount": 1000000,
  "currency": "INR",
  "mode": "NEFT",
  "purpose": "refund",
  "fund_account": {
    "account_type": "card",
    "card": {
      "number": "765432123456789",
      "name": "Gaurav Kumar",
      "input_type": "card"
    },
    "contact": {
      "email": "gaurav.kumar@example.com",
      "contact": "9876543210",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      }
    }
  },
  "queue_if_low_balance": true,
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  }
}'

{
  "id": "pout_00000000000001",
  "entity": "payout",
  "fund_account_id": "fa_00000000000001",
  "fund_account": {
    "id": "fa_00000000000001",
    "entity": "fund_account",
    "contact_id": "cont_00000000000001",
    "contact": {
      "id": "cont_00000000000001",
      "entity": "contact",
      "contact": "9876543210",
      "email": "gaurav.kumar@example.com",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "batch_id": null,
      "active": true,
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      },
      "created_at": 1580817353
    },
    "account_type": "card",
    "card": {
      "last4": "6789",
      "network": "Visa",
      "type": "credit",
      "issuer": "HDFC",
      "input_type": "card"
    },
    "batch_id": null,
    "active": true,
    "created_at": 1581080272
  },
  "amount": 1000000,
  "currency": "INR",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "fees": 590,
  "tax": 90,
  "status": "processed",
  "purpose": "payout",
  "utr": null,
  "mode": "NEFT",
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "batch_id": null,
  "failure_reason": null,
  "created_at": 1581499319,
  "fee_type": "",
  "error": {
    "description": null,
    "source": null,
    "reason": null
  }
}

POST

payouts

curl -u <YOUR_KEY>:<YOUR_SECRET> \
-X POST https://api.razorpay.com/v1/payouts \
-H "Content-Type: application/json" \
-H "X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4" \
-d '{
  "account_number": "7878780080316316",
  "amount": 1000000,
  "currency": "INR",
  "mode": "NEFT",
  "purpose": "refund",
  "fund_account": {
    "account_type": "card",
    "card": {
      "number": "765432123456789",
      "name": "Gaurav Kumar",
      "input_type": "card"
    },
    "contact": {
      "email": "gaurav.kumar@example.com",
      "contact": "9876543210",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      }
    }
  },
  "queue_if_low_balance": true,
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  }
}'

{
  "id": "pout_00000000000001",
  "entity": "payout",
  "fund_account_id": "fa_00000000000001",
  "fund_account": {
    "id": "fa_00000000000001",
    "entity": "fund_account",
    "contact_id": "cont_00000000000001",
    "contact": {
      "id": "cont_00000000000001",
      "entity": "contact",
      "contact": "9876543210",
      "email": "gaurav.kumar@example.com",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "batch_id": null,
      "active": true,
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      },
      "created_at": 1580817353
    },
    "account_type": "card",
    "card": {
      "last4": "6789",
      "network": "Visa",
      "type": "credit",
      "issuer": "HDFC",
      "input_type": "card"
    },
    "batch_id": null,
    "active": true,
    "created_at": 1581080272
  },
  "amount": 1000000,
  "currency": "INR",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "fees": 590,
  "tax": 90,
  "status": "processed",
  "purpose": "payout",
  "utr": null,
  "mode": "NEFT",
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "batch_id": null,
  "failure_reason": null,
  "created_at": 1581499319,
  "fee_type": "",
  "error": {
    "description": null,
    "source": null,
    "reason": null
  }
}

Available in🇮🇳 India🇺🇸 United States

Use this endpoint to create a payout to card using Composite Payout API, without saving the details.

Watch Out!Ensure you allowlist IPs and pass the idempotency key to make a successful payout.

Payout to Cards is only available for PCI DSS compliant merchants. To enable the feature, raise a request on the RazorpayX Dashboard. Refer to the payouts to cards documentation.

Consider the points given below before firing this API:

Contact
- A new contact is created if any combination of the following details is unique:
  - fund_account.contact.name
  - fund_account.contact.email
  - fund_account.contact.contact
  - fund_account.contact.type
  - fund_account.contact.reference_id
- If all the above details match the details of an existing contact, the API returns details of the existing contact.
- Use the Update Contact API if you want to make changes to an existing contact.
Fund Account
- A new fund account is created if any combination of the following details is unique:
  - fund_account.card.name
  - fund_account.card.number
  - fund_account.contact.name
  - fund_account.contact.email
  - fund_account.contact.contact
  - fund_account.contact.type
  - fund_account.contact.reference_id
- If all the above details match the details of an existing fund account, the API returns details of the existing fund account.
- You cannot edit the details of a fund account.

To understand the status of the payouts, refer to Payout Status Details.

curl -u <YOUR_KEY>:<YOUR_SECRET> \
-X POST https://api.razorpay.com/v1/payouts \
-H "Content-Type: application/json" \
-H "X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4" \
-d '{
  "account_number": "7878780080316316",
  "amount": 1000000,
  "currency": "INR",
  "mode": "NEFT",
  "purpose": "refund",
  "fund_account": {
    "account_type": "card",
    "card": {
      "number": "765432123456789",
      "name": "Gaurav Kumar",
      "input_type": "card"
    },
    "contact": {
      "email": "gaurav.kumar@example.com",
      "contact": "9876543210",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      }
    }
  },
  "queue_if_low_balance": true,
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  }
}'

{
  "id": "pout_00000000000001",
  "entity": "payout",
  "fund_account_id": "fa_00000000000001",
  "fund_account": {
    "id": "fa_00000000000001",
    "entity": "fund_account",
    "contact_id": "cont_00000000000001",
    "contact": {
      "id": "cont_00000000000001",
      "entity": "contact",
      "contact": "9876543210",
      "email": "gaurav.kumar@example.com",
      "type": "employee",
      "reference_id": "Acme Contact ID 12345",
      "batch_id": null,
      "active": true,
      "notes": {
        "notes_key_1": "Tea, Earl Grey, Hot",
        "notes_key_2": "Tea, Earl Grey… decaf."
      },
      "created_at": 1580817353
    },
    "account_type": "card",
    "card": {
      "last4": "6789",
      "network": "Visa",
      "type": "credit",
      "issuer": "HDFC",
      "input_type": "card"
    },
    "batch_id": null,
    "active": true,
    "created_at": 1581080272
  },
  "amount": 1000000,
  "currency": "INR",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "fees": 590,
  "tax": 90,
  "status": "processed",
  "purpose": "payout",
  "utr": null,
  "mode": "NEFT",
  "reference_id": "Acme Transaction ID 12345",
  "narration": "Acme Corp Fund Transfer",
  "batch_id": null,
  "failure_reason": null,
  "created_at": 1581499319,
  "fee_type": "",
  "error": {
    "description": null,
    "source": null,
    "reason": null
  }
}

Request Parameters

string

required

The account from which you want to make the payout.
Account details can be found on the RazorpayX Dashboard. 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.
RazorpayX Lite is currently not available for new merchants. To set up a new RazorpayX account, refer to Current Account.

integer

required

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

string

required

The payout currency. Here, it is INR.

string

required

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

NEFT
RTGS
IMPS
UPI
card

The payout modes are case-sensitive. When creating payouts using APIs, ensure payout modes are entered in upper case.

string

required

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.

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.

object

required

The account to which you want to make the payout.

string

required

The type of account linked to the contact id. Here, it will be card.

object

required

The details of the card used.

string

required

Here, the value is card.

string

required

Same field can accept card numbers or card tokens.

string

The name on the card.

string

The expiry month of the entered card.

string

The expiry year of the entered card.

object

required

The Contact’s details.

string

required

Name of the contact. This field is case-sensitive. A minimum of 3 characters and a maximum of 50 characters are allowed. Name cannot end with a special character, except .. Supported characters: a-z, A-Z, 0-9, space, ’ , - , _ , / , ( , ) and .. For example, Gaurav Kumar.

string

The contact’s email address. For example, gaurav.kumar@example.com.

string

The contact’s phone number. For example, 9000090000.

string

Classification for the contact being created. For example, employee. Possible values: vendor, customer, employee, self.

string

A user-generated reference given to the contact. For example, Acme Contact ID 12345. This field can have a maximum length of 40 characters.

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

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.

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.

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

Response Parameters

string

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

string

The entity being created. Here, it will be payout.

string

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

object

Contact and fund account details to which the payout was made.

string

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

string

Here it will be fund_account.

string

The unique identifier linked to the contact. For example, cont_00000000000001.

object

Details of the contact to whom the payout is being made.

string

The unique identifier linked to the contact. For example, cont_00000000000001.

string

The entity being created. Here, it will be contact.

string

The contact’s name. For example, Gaurav Kumar.

string

The contact’s phone number. For example, 9000090000.

string

The contact’s email address. For example, gaurav.kumar@example.com.

string

Classification for the contact being created. For example, employee. Classifications are available by default:

vendor
customer
employee
self

string

A reference you entered for the contact. For example, Acme Contact ID 12345.

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

boolean

Possible values:

true: active
false: inactive

object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”.

integer

Timestamp, in Unix, when the contact was created. For example, 1545320320.

string

The type of fund account being created. It can be a bank_account, vpa, card.

object

The contact’s bank account details.

string

Unique identifier of a bank branch. For example, HDFC0000053.

string

The contact’s bank name. For example, HDFC.

string

Account holder’s name. For example,Gaurav Kumar.

string

Beneficiary account number. For example, 765432123456789.

object

User-entered notes for internal reference.

object

The contact’s virtual payment address (VPA) details.

string

The user name from the virtual payment address. For example, gauravkumar.

string

The handle from the virtual payment address. For example, exampleupi.

string

The virtual payment address. For example, gauravkumar@exampleupi.

object

Details of the credit card that is being used to create the fund account.

string

The credit card holder’s name. For example,Gaurav Kumar.

string

The last four digits of the credit card. For example, 0001.

string

The credit card issuing network. Possible values are:

Visa
Mastercard
American Express
Diners Club

string

Currently, this can only be credit.

string

The name of bank that issued the card. For example, HDFC. Refer to the Supported Banks and Payout Modes section section for more details.

string

This value is returned if the fund account was created as part of a bulk upload. For example, batch_00000000000001.

boolean

Possible values:

true: active
false: inactive

integer

Timestamp, in Unix, when the fund account was created. For example, 1545320320.

integer

Minimum value 100. The payout amount, in paise. For example, if you want to transfer ₹10,000, pass 1000000.
The value passed here does not include fees and tax. Fee and tax, if any, is deducted from your account balance.

string

The payout currency. Here, it is INR.

object

User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”.

integer

The fees for the payout. This value is returned only when the payout moves to the processing state. For example, 5.

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.

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

string

The purpose of the payout. Classifications available by default:

refund
cashback
payout
salary
utility bill
vendor bill

string

The unique transaction number linked to a payout. For example, HDFCN00000000001.

string

The mode used to make the payout. Refer to the Payouts section for more details. Available modes:

NEFT
RTGS
IMPS

string

A reference you entered for the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.

string

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.

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

object

This parameter returns the current status of the payout. For example, IMPS is not enabled on beneficiary account, Retry with different mode.

string

A description for the error. For example, IMPS is not enabled on beneficiary account, please retry with different mode.

string

Possible values:

gateway: Technical error at Razorpay Partner bank.
beneficiary_bank: Technical error at beneficiary bank.
business: Merchant action required.
internal: Technical error at Razorpay’s server.

string

The error reason. For example, imps_not_allowed. Payout Status Details and Next Steps.

integer

Timestamp, in Unix, at which the payout was created. For example, 1545320320.

string

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

​Request Parameters

​Response Parameters

Request Parameters

Response Parameters