Beneficiary
Details of a Beneficiary
System-generated unique identifier for the beneficiary
Client-provided identifier for the beneficiary, used for idempotency or external reference
Possible values: <= 36 characters
Unique identifier of the account associated with this beneficiary
The status of the beneficiary, e.g. VERIFIED
Possible values: [CREATED
, FAILED
, VERIFIED
]
Date and time when the beneficiary was created
personalDetails objectrequired
Beneficiary's personal details
Classification of the beneficiary, such as INDIVIDUAL or BUSINESS
Possible values: [INDIVIDUAL
, BUSINESS
]
Full legal name of the beneficiary
Beneficiary's address line 1
Beneficiary's address line 2, if applicable
City where the beneficiary resides
Province or state where the beneficiary resides
Postal code of the beneficiary's address
Country where the beneficiary resides, in ISO 3166-1 alpha-2 format
Possible values: >= 2 characters
and <= 2 characters
AE
Beneficiary's phone number, including country code
Beneficiary's tax identification number, if applicable
Beneficiary's identification number, such as a passport or national ID
Name of the contact person for the beneficiary, if applicable
bankDetails objectrequired
Beneficiary's bank details
Beneficiary's account number, this is expected to be an iban if the bankCountry is an iban country
Beneficiary's bank identifier code, such as BIC or SWIFT
Code of the beneficiary's bank
BANK123
Currency used for transactions with the beneficiary's bank
AED
Name of the beneficiary's bank
Name of the beneficiary's bank branch
Address of the beneficiary's bank
City where the beneficiary's bank is located
Province or state where the beneficiary's bank is located
Postal code of the beneficiary's bank
Country where the beneficiary's bank is located
Possible values: >= 2 characters
and <= 2 characters
AE
Type of the beneficiary's bank account
Possible values: [CHECKING
, SAVINGS
, STANDARD
, DEPOSIT
, OTHERS
]
SAVINGS
Branch code of the beneficiary's bank, if applicable
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalId": "string",
"accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"beneficiaryStatus": "CREATED",
"createdAt": "2024-07-29T15:51:28.071Z",
"personalDetails": {
"type": "INDIVIDUAL",
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"province": "string",
"postalCode": "string",
"country": "AE",
"phoneNumber": "string",
"taxId": "string",
"idNumber": "string",
"contactName": "string"
},
"bankDetails": {
"accountNumber": "string",
"bic": "string",
"bankCode": "BANK123",
"currency": "AED",
"bankName": "string",
"bankBranchName": "string",
"bankAddress": "string",
"bankCity": "string",
"bankProvince": "string",
"bankPostalCode": "string",
"bankCountry": "AE",
"accountType": "SAVINGS",
"branchCode": "string"
}
}