Create Recipient

Allows a user to create recipient.

Validation failures return 422 with error_code: VALIDATION_ERROR and an errors array. Common reasons: missing first or last name, missing bank name / bank country / BIC code (for non-UAE banks), a future date_of_birth ("Date of birth cannot be in the future."), and IBAN mismatches ("This IBAN does not match the country/currency you selected.").

Creating a recipient does not require any KYC step. A 403 on the recipient endpoints means the request used a wrong or inactive API key, or the wrong environment (for example a sandbox key against production) — it is not a sign that a feature is disabled for your account.

The canonical path is /recipients. The /accounts/recipients alias points at the same resource but does not expose the balances endpoint, so prefer /recipients.

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
Headers
string
Responses

404

Invalid request

500

Unexpected error

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