Beneficiaries

A fiat beneficiary represents a specific payout destination — a bank account or mobile wallet — tied to a currency and a payment channel. The payment channel ID tells Onboard exactly how to route the payout (e.g. SEPA vs. local bank transfer for EUR), and determines which beneficiary fields are required.

Currencies and payment channels

Each currency supports one or more payment channels, and each channel maps to a specific beneficiary type:

Currency	Payment Channel	Channel ID	Beneficiary Type
EUR	SEPA - International	`BANK_TRANSFER_SEPA`	`BeneficiarySepaBankAccount`
GBP	Fast Payment UK	`BANK_TRANSFER_UK`	`BeneficiaryLocalBankAccount`
GHS	Vodafone Cash	`VODAFONE_CASH`	`BeneficiaryMobileWalletAccount`
GHS	Telecel Ghana	`TELECEL_GHANA`	`BeneficiaryMobileWalletAccount`
GHS	Bank Transfer - Ghana	`BANK_TRANSFER_GHANA`	`BeneficiaryLocalBankAccount`
GHS	AirtelTigo Ghana	`AIRTEL_TIGO_GHANA`	`BeneficiaryMobileWalletAccount`
GHS	Zeepay	`ZEEPAY`	`BeneficiaryMobileWalletAccount`
GHS	MTN Mobile Money - Ghana	`MTN_MOBILE_MONEY_GH`	`BeneficiaryMobileWalletAccount`
IDR	Gopay	`GOPAY_IN`	`BeneficiaryMobileWalletAccount`
IDR	DANA	`DANA_IN`	`BeneficiaryMobileWalletAccount`
IDR	Bank Transfer - Indonesia	`BANK_TRANSFER_INDONESIA`	`BeneficiaryLocalBankAccount`
IDR	LinkAja	`LINK_AJA`	`BeneficiaryMobileWalletAccount`
KES	M-PESA Kenya (Safaricom)	`M_PESA_KENYA_SAFARICOM`	`BeneficiaryMobileWalletAccount`
KES	Bank Transfer - Kenya	`BANK_TRANSFER_KENYA`	`BeneficiaryLocalBankAccount`
NGN	Bank Transfer - Nigeria	`BANK_TRANSFER_NIGERIA`	`BeneficiaryLocalBankAccount`
USD	ACH - United States	`BANK_TRANSFER_ACH`	`BeneficiaryLocalBankAccount`
USD	SWIFT - International	`BANK_TRANSFER_SWIFT`	`BeneficiaryLocalBankAccount`
USD	Wire	`BANK_TRANSFER_WIRE`	`BeneficiaryLocalBankAccount`

Call GET /ledger/cash-payments/currencies to fetch this list live — new currencies and channels are added over time.

Managing beneficiaries

GET /ledger/fiat-beneficiaries — list saved beneficiaries.
POST /ledger/fiat-beneficiaries — add a beneficiary for a given currency and payment channel.
GET /ledger/fiat-beneficiaries/{beneficiaryId} — fetch a single beneficiary.
DELETE /ledger/fiat-beneficiaries/{beneficiaryId} — remove a beneficiary.

Getting Started

API Concepts

Product Features

Use Cases

Currencies and payment channels

Managing beneficiaries

​Currencies and payment channels

​Managing beneficiaries

Currencies and payment channels

Managing beneficiaries