ledger-payments

Create transfer quote

Changed on

Create quote for cash payment

post/ledger/cash-payments/quotes

Request

  • Base URL
    https://external.dev.onboardpay.co
  • Auth
    API key in header x-api-key

Request body

payoutCurrencystring required

Currency of the payout to the beneficiary.

accountCurrencystring required

Currency of the account to be debited.

amountnumber required
unitCurrencystring

Should be same as one of payout or account currencies. Defaults to account currency if not provided.

Example request

{
  "payoutCurrency": "NGN",
  "accountCurrency": "USD",
  "amount": 100,
  "unitCurrency": "USD"
}

Response

Quote created

idstring uuid required

Unique identifier for the transfer quote.

accountCurrencystring required

Currency of the account to be debited.

payoutCurrencystring required

Currency of the payout to the beneficiary.

ratenumber required

Exchange rate applied for this quote

minimumAmountnumber required

Minimum amount allowed for this quote

maximumAmountnumber required

Maximum amount allowed for this quote

minimumPayoutAmountnumber

Minimum payout amount allowed for this quote

maximumPayoutAmountnumber

Maximum payout amount allowed for this quote

feeAmountnumber

Platform fee, in accountCurrency, that would apply based on the business's configured fee preference (zero if none configured). Informational only for now — not yet reflected in minimumAmount/maximumAmount or in the amount actually debited once the payment is created; wiring it into the settled amount is a tracked follow-up.

feeInclusiveboolean

The fee's intended relationship to the debited amount once wired into settlement (false = additive, matching crypto withdrawals). Has no effect on the actual debited amount today.

expiresAtstring date-time required

Timestamp field.

Example response

{
  "accountCurrency": "USD",
  "payoutCurrency": "NGN",
  "rate": 1450.75,
  "minimumAmount": 50,
  "maximumAmount": 10000,
  "minimumPayoutAmount": 72500,
  "maximumPayoutAmount": 14507500,
  "feeAmount": 0.5
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the endpoint scheme security HMACAuth was added to the API

    • info

      the endpoint scheme security authToken was removed from the API