PagedModelBeneficiary

content object[]

Array [

iduuidrequired

System-generated unique identifier for the beneficiary

externalIdstringrequired

Client-provided identifier for the beneficiary, used for idempotency or external reference

Possible values: <= 36 characters

accountIduuidrequired

Unique identifier of the account associated with this beneficiary

beneficiaryStatusstringrequired

The status of the beneficiary, e.g. VERIFIED

Possible values: [CREATED, FAILED, VERIFIED]

createdAtdate-timerequired

Date and time when the beneficiary was created

personalDetails objectrequired

Beneficiary's personal details

typestringrequired

Classification of the beneficiary, such as INDIVIDUAL or BUSINESS

Possible values: [INDIVIDUAL, BUSINESS]

namestringrequired

Full legal name of the beneficiary

addressLine1stringrequired

Beneficiary's address line 1

addressLine2string

Beneficiary's address line 2, if applicable

citystring

City where the beneficiary resides

provincestring

Province or state where the beneficiary resides

postalCodestring

Postal code of the beneficiary's address

countrystringrequired

Country where the beneficiary resides, in ISO 3166-1 alpha-2 format

Possible values: >= 2 characters and <= 2 characters

Example: AE

phoneNumberstring

Beneficiary's phone number, including country code

taxIdstring

Beneficiary's tax identification number, if applicable

idNumberstring

Beneficiary's identification number, such as a passport or national ID

contactNamestring

Name of the contact person for the beneficiary, if applicable

bankDetails objectrequired

Beneficiary's bank details

accountNumberstringrequired

Beneficiary's account number, this is expected to be an iban if the bankCountry is an iban country

bicstringrequired

Beneficiary's bank identifier code, such as BIC or SWIFT

bankCodestring

Code of the beneficiary's bank

Example: BANK123

currencystringrequired

Currency used for transactions with the beneficiary's bank

Example: AED

bankNamestring

Name of the beneficiary's bank

bankBranchNamestring

Name of the beneficiary's bank branch

bankAddressstring

Address of the beneficiary's bank

bankCitystring

City where the beneficiary's bank is located

bankProvincestring

Province or state where the beneficiary's bank is located

bankPostalCodestring

Postal code of the beneficiary's bank

bankCountrystringrequired

Country where the beneficiary's bank is located

Possible values: >= 2 characters and <= 2 characters

Example: AE

accountTypestring

Type of the beneficiary's bank account

Possible values: [CHECKING, SAVINGS, STANDARD, DEPOSIT, OTHERS]

Example: SAVINGS

branchCodestring

Branch code of the beneficiary's bank, if applicable

]

page object

sizeint64

numberint64

totalElementsint64

totalPagesint64

PagedModelBeneficiary

{
  "content": [
    {
      "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"
      }
    }
  ],
  "page": {
    "size": 0,
    "number": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}