Beneficiaries

The NRE account holder receiving INR.

Create a beneficiary#

POST/v1/beneficiaries

namestringRequired

Account holder's name, as the bank holds it.

account_numberstringRequired

Bank account number.

ifscstringRequired

11-character IFSC of the branch.

account_typestringRequired

nre.

emailstring

Contact email.

phonestring

E.164, e.g. +919876543210.

metadataobject

Your own key-value references.

JSON

{
  "name": "Anita Raghunathan",
  "account_number": "50100123456789",
  "ifsc": "HDFC0000261",
  "account_type": "nre",
  "email": "anita@example.com",
  "phone": "+919876543210",
  "metadata": { "customer_ref": "CUS-8812" }
}

JSON

{
  "object": "beneficiary",
  "id": "beneficiary_01K5X8QP2A9WKXR6MJ4EYT7NDV",
  "name": "Anita Raghunathan",
  "account_number_last4": "6789",
  "ifsc": "HDFC0000261",
  "account_type": "nre",
  "status": "verifying",
  "payouts_enabled": false,
  "created": 1789041600,
  "livemode": true
}

The full account number is never returned — only account_number_last4.

Preview

Extra KYC fields (e.g. PAN, passport) may become required. Activation is expected within one business day.

Status#

draftverifyingactive

Status	Meaning
`draft`	Created, not yet submitted
`verifying`	Checks running
`active`	Ready — payable when `payouts_enabled` is `true`
`input_required`	Update the beneficiary to continue
`rejected`	Cannot be paid

Poll, or subscribe to beneficiary.status.*.

Retrieve, list, update#

GET/v1/beneficiaries/:id

GET/v1/beneficiaries

POST/v1/beneficiaries/:id

Update is allowed only while draft or input_required.