v3

latestOpenAPI 3.0.3UNLICENSED2026-07-2796235396.3 KB
ledger-beneficiaries

Customer beneficiary

This Operation allows user to save beneficiary

post/ledger/fiat-beneficiaries

Request body

accountNumberstring required

Beneficiary account number, for international payments like SEPA, this is the IBAN, and for Mobile Money, this is the phone number.

accountNamestring required

Beneficiary account name

currencystring required
beneficiaryTypestring required

Discriminator value for beneficiary type. Possible values are:

  • CreateLocalBankAccountBeneficiary: Local bank transfer beneficiary, maps to BeneficiaryLocalBankAccount
  • CreateSepaBankAccountBeneficiary: SEPA instant and standard transfer beneficiary. Use this for beneficiaries that will receive SEPA payments. Maps to BeneficiarySepaBankAccount
  • CreateACHBankAccountBeneficiary: ACH, FedWire and FedNow transfer beneficiary. Maps to BeneficiaryACHBankAccount
  • CreateSwiftBankAccountBeneficiary: SWIFT transfer beneficiary. Maps to BeneficiarySwiftBankAccount
  • CreateMobileWalletAccountBeneficiary: Use this for beneficiaries that will receive mobile wallet payments. Maps to BeneficiaryMobileWalletAccount.
isThirdPartyboolean

Flag to indicate if the beneficiary is a third party

accountHolderType'INDIVIDUAL' | 'BUSINESS' required
paymentChannelIdstring required

To get the payment channels available, call the /currencies endpoint. The payment channel ID to be used for transfer to this beneficiary. The payment channel ID and the beneficiaryType are mutually exclusive. For example BANK_TRANSFER_NIGERIA uses CreateLocalBankAccountBeneficiary

Response

Beneficiary details saved successfully

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