Get reference rate

Get reference rate for cash payments

get/ledger/cash-payments/rates

Request

Base URL
https://external.dev.onboardpay.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/docs/ledger/cash-payments/rates/get.ts
A function with typed inputs. Its response is checked against the schema.

accountCurrencystring required

payoutCurrencystring required

Rate retrieved

accountCurrencystring required

cashCurrencystring required

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

ratenumber required

{
  "accountCurrency": "USD",
  "cashCurrency": "NGN",
  "rate": 1500.5
}

Jul 26, 2026a3c4e2742615 Revision changes
- info
  the endpoint scheme security HMACAuth was added to the API
- info
  the endpoint scheme security authToken was removed from the API
Jul 13, 2026fc790ea4deb6 Revision changes
- info
  endpoint added