Skip to main content
Use this endpoint to create a fund account type card by saving the card with Razorpay TokenHQ.

​
Request

Curl

​
Response

Success

​
Parameters

contact_id mandatory : string The unique identifier of the contact for which you want to fetch payouts. For example, cont_00000000000001. account_type mandatory : string The type of account linked to the contact id. Here, it will be card. card mandatory : object The details of the card used. input_type mandatory : string Here, the value is razorpay_token. token_provider mandatory : string The name of the aggregator that provided the token. token_id mandatory : string The unique identifier of the token to which the payout has to be made. If it is razorpay_token then the token_id must be present.

​
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. id : string The unique identifier linked to the fund account. For example, fa_00000000000001. account_type : string The type of account linked to the contact id. Here, it will be card. contact_id : string The unique identifier linked to the contact. For example, cont_00000000000001. contact : object id : string The unique identifier linked to the contact. For example, cont_00000000000001. entity : string The entity being created. Here, it will be contact. name : string The contact’s name. For example, Gaurav Kumar. contact : string The contact’s phone number. For example, 9000090000. email : string The contact’s email address. For example, gaurav.kumar@example.com. type : string A classification for the contact being created. For example, employee. reference_id : string A user-entered reference for the contact. For example, Acme Contact ID 12345. batch_id : string This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001. active : boolean Possible values:
  • true (default): active
  • false: inactive
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”. created_at : integer Timestamp, in Unix, when the contact was created. For example, 1545320320. card : object The details of the card used. last4 : string The last 4 digits of the card number. If the input_type = service_provider_token then it is the last 4 digits of the card token. network : string The network operator that has issued the card. For example, Mastercard, Visa. type : string The type of card. For example, credit or debit. issuer : string The bank that has issued the card. For example, ICIC, HDFC. input_type : string Possible values:- service_provider_token : When the token number used is provided by an external service.
  • card : When a card number is provided.
  • razorpay_token : When the token id used is provided by Razorpay.
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. description : string A description for the error. For example, IMPS is not enabled on beneficiary account, please retry with different mode. source : 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.
reason : string The error reason. For example, imps_not_allowed. Know more about Payout Status Details and Next Steps. 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.