Skip to main content
POST
Payout Fee

Authorizations

Authorization
string
header
required

Secret API key from Settings → Developers → API keys. Example: Authorization: Bearer sk_test_…

Body

application/json
beneficiary_id
string<uuid>
required

Beneficiary the fee estimate applies to.

Example:

"bbd938a2-dbbe-43bf-bfb9-1c5dbe444523"

currency
string
required

Source book currency for the planned send.

Example:

"NGN"

amount
integer
required

Planned send amount in Ledger minor units.

Example:

5000000

quote_id
string<uuid>

Optional firm quote id for cross-currency fee accuracy.

recipient_amount
integer

Optional estimated recipient amount in their currency minor units when you do not yet have a firm quote_id.

Response

Fee quote

object
enum<string>

Object type discriminator.

Available options:
payout_fee
currency
string

Currency of amount, transfer_fee, and total.

amount
integer

Requested send amount in Ledger minor units.

transfer_fee
integer

Estimated customer-visible transfer fee in minor units.

total
integer

Amount plus fee (what leaves the book), in minor units.

exact
boolean

true when the fee is final for this input; false when indicative (e.g. before a firm FX quote).

min_payment
integer

Minimum allowed send for this corridor, if applicable.

scale
integer

Decimal places for the currency (usually 2).