Skip to main content
GET
Get reference rate
Fetches current FX rates for cash deposits.

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.

Query Parameters

accountCurrency
string
required
payinCurrency
string
required

Response

Rate retrieved

accountCurrency
string
required
Example:

"USD"

cashCurrency
string
required

The cash (fiat) currency. For cash payments this is the payout currency; for cash deposits the pay-in currency.

Example:

"NGN"

rate
number
required
Example:

1500.5