Create Recipient

Creates a recipient: a person or business you can pay out to. Use the returned id (REP-...) as recipient_id when you create a payout or split a payment link with payouts_share (see Marketplace split payments).

recipient_type, relationship, and bank are required. Send first_name and last_name for an individual, or business_name for a business. In bank, send either an iban or an account_number. If you leave out bank.country, it defaults to AE. To check an IBAN first, use Validate IBAN.

Creating a recipient has no KYC step of its own.

Validation errors

A failed validation returns 422 with error_code: VALIDATION_ERROR and an errors array. Common causes:

  • first_name or last_name missing for an individual, or business_name missing for a business.
  • bank.name missing when you send an account_number or a non-UAE IBAN.
  • bank.address or bank.country missing when you send an account_number.
  • bank.bic_code missing when you send an account_number for a bank outside the US and India.
  • An iban that isn't a valid IBAN.
  • A date_of_birth in the future ("Date of birth cannot be in the future.").
  • Fields required by the payout corridor. For example, for an Indian bank (bank.country: IN) you must send phone_number, plus nationality and eid_number for an individual or business_registration_number for a business.

If the recipient passes validation but can't be saved, you get 422 with error_code: UNPROCESSABLE_ENTITY and the message Can not create recipient.

A 403 means the API key is missing, wrong, or inactive, or belongs to the other environment (for example a sandbox key sent to production), or your account is blocked. It is not a sign that recipients are disabled for your account. See Errors.

📘

Use /recipients

/accounts/recipients is an alias for the same resource, but it doesn't expose the balances endpoint. Use /recipients.

Recipes
🦉
Pay a recipient
Open Recipe
🦉
Run a marketplace: collect, hold, split and pay sellers
Open Recipe
Body Params
string
enum
required
Defaults to individual

The type of the recipient.

Allowed:
string

Recipient's email.

string

Name of the recipient when recipient_type is business.

string

First name of the recipient when recipient_type is individual.

string

Last name of the recipient when recipient_type is individual.

string
enum
required

Recipient's relationship

string

Recipient's Emirates ID number.

string

Recipient's phone number. Required for some corridors (for example India).

string
enum

Recipient's identity document type. Required for some corridors.

string

Recipient's business registration number, when recipient_type is business. Required for some corridors.

string

Recipient's nationality as a three-letter ISO 3166-1 alpha-3 country code (for example: ARE, GBR).

date

Recipient's date of birth in YYYY-MM-DD format. Cannot be a future date.

bank
object
required
address
object
recipient_meta
object
Responses

404

Invalid request

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json