Update Recipient

Allows a user to update recipient details.

Path Params
string
required
Defaults to REP-6BB7CA8DC7

Recipient Identifier

Body Params
string
enum
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

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
address
object
recipient_meta
object
Headers
string
Responses

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