Skip to main content
POST
Create transfer quote
Generates a rate-locked quote for a cash payout.

Authorizations

x-api-key
string
header
required

Requires authentication via API key and HMAC signature.

  • x-api-key: Your API key generated from your Onboard Business dashboard.
  • x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Body

application/json
payoutCurrency
string
required

Currency of the payout to the beneficiary.

Example:

"NGN"

accountCurrency
string
required

Currency of the account to be debited.

Example:

"USD"

amount
number
required
Required range: x > 0Must be a multiple of 0.01
Example:

100

unitCurrency
string

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

Example:

"USD"

Response

Quote created

id
string<uuid>
required

Unique identifier for the transfer quote.

accountCurrency
string
required

Currency of the account to be debited.

Example:

"USD"

payoutCurrency
string
required

Currency of the payout to the beneficiary.

Example:

"NGN"

rate
number
required

Exchange rate applied for this quote

Example:

1450.75

minimumAmount
number
required

Minimum amount allowed for this quote

Example:

50

maximumAmount
number
required

Maximum amount allowed for this quote

Example:

10000

expiresAt
string<date-time>
required

Timestamp field.

minimumPayoutAmount
number

Minimum payout amount allowed for this quote

Example:

72500

maximumPayoutAmount
number

Maximum payout amount allowed for this quote

Example:

14507500