Skip to main content
POST
Node.js
Required scope: quotes:write Send sourceAmount; Ledig calculates destinationAmount. For a same-currency payment, include payOut. payIn with temporary_bank_account is not supported and returns 501. A quote can be used once through POST /v1/transfers. Check conversion limits in GET /v1/liquidity/routes, measured in the source currency, and payout limits in GET /v1/payouts/catalogue, measured in the destination currency. Quote creation checks the amount, current availability and your source balance including fees. Handle 404 RATE_NOT_FOUND, 422 RATE_ROUTE_AMOUNT_OUT_OF_RANGE and 409 INSUFFICIENT_BALANCE separately. Your business’s per-payment and monthly payout allowances are separate limits measured in USD equivalent and are checked when you create the transfer. Both new and replayed responses use HTTP 201: replayed=false means a new quote, and replayed=true returns the original quote for the same reference without renewing its expiry. An expired or accepted quote may be returned by a replay; use a fresh reference when you deliberately request a fresh quote. This endpoint does not use Idempotency-Key.

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.

Body

application/json
sourceCurrency
string
required
Required string length: 2 - 20
destinationCurrency
string
required
Required string length: 2 - 20
sourceAmount
string
required

A positive decimal amount within sourceCurrency's supported precision. Extra trailing zeroes are accepted, but extra non-zero decimal places are rejected without rounding. For a zero-decimal currency, 10 and 10.000 are accepted; 10.1 is rejected.

reference
string
Maximum string length: 64
payIn
object
payOut
object

Use recipientId for a saved destination. To pay another Ledig business, use businessId without saving a recipient. Existing ledig payments using recipientId remain supported; use businessId for new integrations. Business names are looked up by Ledig and are not accepted here.

Response

Quote created or the original quote recovered. replayed distinguishes an existing result.

status
string
required
Allowed value: "success"
replayed
boolean
required

True when the original resource is returned without creating another operation.

data
object
required

Confirmed conversion or payment terms. Amounts are decimal strings; totalSourceDebitAmount includes conversion and payout fees.

message
string