Skip to main content
POST
Node.js
Required scope: quotes:read Read Only API keys can call this endpoint even though it uses POST. Custom keys need quotes:read, and your business needs access to quotes. This does not give the key access to other POST endpoints. Send a positive decimal amount with the currency’s supported precision. For crypto, send the exact network ID; omit network for bank or mobile money payouts. If more than one fee band matches, send a bandId from GET /v1/payouts/catalogue. An unknown bandId is rejected. Selecting a band can return its fee even when the amount is outside its limits; check amountWithinLimits and payout availability. Use the returned feeAmount instead of calculating the fee yourself. Missing or ambiguous pricing is not a zero fee. This request creates no quote or payment. Create a fresh quote before sending. Responses use Cache-Control: private, no-store.

Authorizations

Authorization
string
header
required

A user access token from sign-in. Send Authorization: Bearer followed by the token. Use this only on endpoints that list BearerAuth.

Headers

X-Ledig-Business-Id
string

The business you are acting for. For a managed business, your institution must be authorised to act for it and API-key requests must use HMAC v2. Set this header explicitly; a business ID in the body does not select the business.

Minimum string length: 1
X-Ledig-Acting-Business-Id
string

Your institution's business ID when acting for a managed business. It must match your API key's owner or an institution you belong to. HMAC v2 signs the trimmed value, or an empty string when omitted.

Minimum string length: 1
X-Ledig-Profile-Id
string

An optional business selection header supported by existing integrations. For a managed business, omit it or use the same value as X-Ledig-Business-Id. HMAC v2 includes it in the signed request.

Minimum string length: 1

Body

application/json
currency
string
required
Pattern: ^[A-Za-z][A-Za-z0-9]{1,11}$
payoutType
enum<string>
required
Available options:
fiat,
crypto
amount
string
required

A positive amount using no more than the selected currency's supported decimal places.

Pattern: ^(?:0|[1-9]\d{0,18})(?:\.\d{1,18})?$
network
string

The exact network ID for a crypto payout. Omit for bank or mobile money payouts.

Required string length: 1 - 100
bandId
string
Pattern: ^pbd_[a-f0-9]{32}$

Response

The estimated fee, or an explanation that pricing is unavailable. Payout availability is shown separately.

status
string
required
Allowed value: "success"
data
object
required
message
string