Skip to main content
GET
Node.js
Required scope: quotes:read Use type=withdraw for payouts and type=deposit for receiving options. For a payout, provide amount in the destination currency to show methods that cover it. Use the returned deliveryOptions to choose a method and pass its values unchanged in the quote. External payout options include amountBands; minimumAmount and maximumAmount are their outer bounds, so keep gaps between bands unsupported. Limits apply to the selected method or network, not to every payment in that currency. GET /v1/payouts/catalogue lists fee bands separately. Missing options or limits do not mean unlimited payments. Discovery does not approve a payment. HTTP 423 COMPLIANCE_REVIEW_REQUIRED means the destination needs review; do not retry automatically or create a replacement recipient. HTTP 404 means the requested recipient was not found.

Authorizations

x-ledig-key
string
header
required

Your business API key ID. Keep its secret on your server and use that secret to sign each request.

x-ledig-timestamp
string
header
required

The current Unix timestamp in seconds, used in the signed request.

x-ledig-signature
string
header
required

The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.

Query Parameters

type
enum<string>
required
Available options:
deposit,
withdraw
currency
string
required
Minimum string length: 1
amount
string
Pattern: ^(?=.*[1-9])(0|[1-9]\d*)(?:\.\d+)?$
chain
string

The crypto network to use when checking your business's payout fees.

Required string length: 1 - 100
recipientId
string

A recipient saved by your business. Use it to filter payout options; it is not accepted for deposit options.

Required string length: 1 - 200
businessId
string

The Ledig business you want to pay. Use with type=withdraw, omit chain and do not also supply recipientId.

Required string length: 1 - 200
paymentMethodId
string

The payout method whose availability you want explained. Creating a quote and sending the payment check availability again.

Required string length: 1 - 200

Response

Eligible deposit or withdrawal payment options.

status
string
required
Allowed value: "success"
data
object[]
required
message
string
availability
object

Availability of the selected payout method. Amount limits use the destination currency; conversion limits are separate. Availability is checked again when you send.