---
title: "Get reference rate"
method: GET
path: "/ledger/cash-payments/rates"
tags: ["ledger-payments"]
---

# Get reference rate

`GET /ledger/cash-payments/rates`

## Request

- Base URL: `https://external.dev.onboardpay.co`
- URL: `https://external.dev.onboardpay.co/ledger/cash-payments/rates`
- 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)

Get reference rate for cash payments

## Query parameters

- `accountCurrency` string, required
- `payoutCurrency` string, required

## Response `200`

Rate retrieved

- TransferRate
  - `accountCurrency` string, required
  - `cashCurrency` string, required: The cash (fiat) currency. For cash payments this is the payout currency; for cash deposits the pay-in currency.
  - `rate` number, required

## Other responses

- `400`: Request could not be validated
- `401`: Client is not authorized to make request

## Changes

- **2026-07-26** `a3c4e2742615`: 2 info
  - the endpoint scheme security `HMACAuth` was added to the API
  - the endpoint scheme security `authToken` was removed from the API
- **2026-07-13** `fc790ea4deb6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/cash-payments/rates/get.md)

---

[API](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway.md) - [All operations](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/revisions/5da9ec1b2573?raw)