---
title: "Create deposit quote"
method: POST
path: "/ledger/cash-deposits/quotes"
tags: ["ledger-cash deposits"]
---

# Create deposit quote

`POST /ledger/cash-deposits/quotes`

## Request

- Base URL: `https://external.dev.onboardpay.co`
- URL: `https://external.dev.onboardpay.co/ledger/cash-deposits/quotes`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/docs/ledger/cash-deposits/quotes/post.ts> (a function with typed inputs; its response is checked against the schema)

Create quote for cash deposit

## Request body

- CreateDepositQuoteRequest
  - `payinCurrency` string, required: Currency the customer pays in.
  - `accountCurrency` string, required: Currency of the account to be credited.
  - `amount` number, required
  - `unitCurrency` string: Should be same as one of pay-in or account currencies. Defaults to account currency if not provided.

## Response `200`

Quote created

- CashDepositQuote
  - `id` string, uuid, required: Unique identifier for the deposit quote.
  - `accountCurrency` string, required: Currency of the account to be credited.
  - `payinCurrency` string, required: Currency the customer pays in.
  - `rate` number, required: Exchange rate applied for this quote
  - `minimumAmount` number, required: Minimum amount allowed for this quote
  - `maximumAmount` number, required: Maximum amount allowed for this quote
  - `minimumPayinAmount` number: Minimum pay-in amount allowed for this quote
  - `maximumPayinAmount` number: Maximum pay-in amount allowed for this quote
  - `feeAmount` number: Platform fee, in accountCurrency, that would apply based on the business's configured fee preference (zero if none configured). Informational only for now — not yet reflected in minimumAmount/maximumAmount or in the amount actually credited once the deposit settles; wiring it into the settled amount is a tracked follow-up.
  - `feeInclusive` boolean: The fee's intended relationship to the credited amount once wired into settlement (true = already netted out, matching Graph USD deposits). Has no effect on the credited amount today.
  - `expiresAt` string, date-time, required: Timestamp field.

## Other responses

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

## Changes

- **2026-08-21** `76329919f8a7`: 2 info
  - added the optional property `feeAmount` to the response with the `200` status
  - added the optional property `feeInclusive` to the response with the `200` status
- **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-deposits/quotes/post.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)
