Sign in

v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Create Transfer - Account Beneficiary

Use this API to transfer money from a virtual account to an account number beneficiary.

post/v1/transfers

Request body

typestring required

The account type to which you want to make the transfer. <br><br>Possible value: account_number

debit_account_idstring required

The account_id from which money should be debited.<br><br>Example: va_Q6USeYXbx38cKa3NbBpoHDViW

beneficiary_idstring required

The account_id to which money should be credited.<br><br>Example: vab_ZPdnNajZkGlu5xrNDVjZNrb3d

amountnumber float required

Amount you want to transfer in rupees.<br><br>Example: 369.71

currency_codestring required

ISO code of the currency in which you want to make the transfer.<br>Currently, only inr is allowed.<br><br>Example: inr

payment_modestring required

The mode you want to use to make the transfer.<br>Possible values:<ul><li>neft<li>imps <li>rtgs</ul></li>

asyncboolean

Helps improve success rate when creating multiple transfers in a short duration.<br><br>Possible values:<ul><li>true: The transfer is added to a queue and sent to the bank asynchronously. <li>false (default): The transfer request is sent to the bank immediately.</ul></li>

merchant_reference_idstring required

Unique identifier entered when creating the transfer.<br><ul><li>Only alphabets and numbers are allowed.</li><li>Minimum: 7 characters.</li><li>Maximum: 40 characters.</li></ul>Example: 1409614085

payment_remarkstring

Remark for the transfer. This is shown in the bank statement.<ul><li>Only alphabets and numbers are allowed.</li><li>Minimum: 1 character.</li><li>Maximum: 40 characters.</li></ul>Example: Transfer via ZWITCH.

Response

200

OR
OR

Example response

{
  "id": "tr_aTKJAon8uLYqyk7wpP3kFAaYs",
  "object": "transfer",
  "type": "account_number",
  "amount": 1,
  "debit_account_id": "va_3Zk64YDxnBtyvkzWoIVUOIWHu",
  "beneficiary_id": "vab_KT8z4g7wlXNbef9gU5IR48PCF",
  "status": "success",
  "bank_reference_number": "214516704238",
  "currency_code": "inr",
  "payment_mode": "imps",
  "payment_remark": "Lego Death Star",
  "paid_to": "54055602160",
  "beneficiary_name": "Sunil Reddy",
  "beneficiary_ifsc": "HDFC0000123",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "merchant_reference_id": "1000077",
  "transacted_at": 1653476654,
  "created_at": 1653476653
}