Sign in
ledger-beneficiaries

Fetch Beneficiary by Id

This operation allows the client to fetch a beneficiary by its Id

get/ledger/fiat-beneficiaries/{beneficiaryId}

Path parameters

beneficiaryIdstring uuid required

The unique ID of a beneficiary

Response

Beneficiary fetched

idstring uuid required

Beneficiary identifier

accountNumberstring required

Beneficiary account number, for international payments like SEPA, this is the IBAN

accountNamestring required

Beneficiary account name

currencystring required
beneficiaryTypestring

Discriminator value for beneficiary type. Allowed values include:

  • BeneficiaryLocalBankAccount
  • BeneficiarySepaBankAccount
  • BeneficiaryACHBankAccount
  • BeneficiarySwiftBankAccount
  • BeneficiaryMobileWalletAccount
isThirdPartyboolean

Flag to indicate if the beneficiary is a third party

accountHolderType'INDIVIDUAL' | 'BUSINESS' required