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

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
payinCurrency
string
required

Currency the customer pays in.

Example:

"NGN"

accountCurrency
string
required

Currency of the account to be credited.

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 pay-in or account currencies. Defaults to account currency if not provided.

Example:

"USD"

Response

Quote created

id
string<uuid>
required

Unique identifier for the deposit quote.

accountCurrency
string
required

Currency of the account to be credited.

Example:

"USD"

payinCurrency
string
required

Currency the customer pays in.

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.

minimumPayinAmount
number

Minimum pay-in amount allowed for this quote

Example:

72500

maximumPayinAmount
number

Maximum pay-in amount allowed for this quote

Example:

14507500