Skip to main content

Get beneficiary

GET 
/api/v1/beneficiaries/:id

Fetches the beneficiary details based on provided id

Request​

Path Parameters

    id stringrequired

    Unique identifier of the beneficiary

    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Header Parameters

    ApiKey stringrequired
    AccountId stringrequired

Responses​

OK

Schema
    id uuidrequired

    Unique identifier for the beneficiary

    shortId stringrequired

    Short, human-readable ID for the beneficiary

    externalId stringrequired

    Unique ID from an external system

    type stringrequired

    Possible values: [INDIVIDUAL, BUSINESS]

    Type of Beneficiary

    name stringrequired

    Full name of the beneficiary

    currency stringrequired

    Possible values: Value must match regular expression [A-Z]{3}

    Currency used for transactions with the beneficiary

    beneficiaryAddress object

    Details of the Beneficiary's physical address

    addressLine1 stringrequired

    Possible values: <= 35 characters

    First line of the address

    addressLine2 string

    Possible values: <= 35 characters

    Second line of the address (if any)

    city string

    Possible values: <= 35 characters

    City of the address

    countryIso2 stringrequired

    Country of the address

    postalCode string

    Possible values: <= 35 characters

    Postal code of the address

    accountNumber string

    Account number of the beneficiary in the bank

    bankCode string

    Code of the beneficiary's bank

    iban string

    International Bank Account Number of the beneficiary

    bic string

    Bank Identifier Code of the beneficiary's bank

    intermediaryBankIdentifier string

    Identifier of the intermediary bank, if any

    bankCountry stringrequired

    Country where the beneficiary's bank is located

Loading...