---
title: "Get a card package's terms."
method: GET
path: "/ledger/card-packages/{packageId}/terms"
tags: ["ledger-card terms"]
---

# Get a card package's terms.

`GET /ledger/card-packages/{packageId}/terms`

## Request

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

Get the current creation/funding/withdrawal fees and funding limits for one card package -
mirrors onboard-wallet-cards' GET /card-packages/{packageId}/terms. `packageId` is a card
provider ID as returned by GET /card-packages (e.g. `onb-cards`).

## Path parameters

- `packageId` string, required

## Response `200`

Card package terms fetched successfully

- CardFeeSchedule: Fees and funding limits for a card package. Fees may be flat or a percentage of the transaction (see CardUsageFee); FLAT fee amounts and the funding limits are provider-level, currency-agnostic figures (not scaled per currency). Computed and owned entirely by the ledger - never fetched from the card provider directly.
  - `packageId` string, required
  - `creationFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `fundingFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `withdrawalFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `fxTransactionFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `transactionFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `maintenanceFee` CardUsageFee, required: A single card fee. A flat amount, or a percentage of the transaction with an optional fixed add-on and min/max caps. e.g. "3.5% + $0.50, min $1, max $20" is amountType=PERCENT, amount=3.5, fixedValue=0.5, minValue=1, maxValue=20. Computed and owned entirely by the ledger - never fetched from the card provider directly.
    - `amount` number, required: The fee amount - in card currency when amountType is FLAT, or a percentage when PERCENT.
    - `amountType` 'FLAT' | 'PERCENT': How a fee amount is applied. * FLAT: a flat amount charged, in the same currency as the card. * PERCENT: the amount is a percentage (usually less than 100) of the transaction amount.
    - `frequency` 'RECURRING' | 'ONE_TIME' | 'AD_HOC': When a fee is charged. Carried for parity with onboard-wallet-cards; the ledger only charges one-time/ad-hoc card fees and does not enforce RECURRING scheduling. * RECURRING: charged at regular intervals over the account's life. * ONE_TIME: charged only once, e.g. at card creation. * AD_HOC: charged when a particular action happens, e.g. a top-up or withdrawal.
    - `recurrenceCount` integer: The number of times a RECURRING fee recurs within its cycle. Carried for parity; unused.
    - `recurrenceFrequency` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Frequency of a RECURRING fee. Carried for parity only; not enforced by the ledger.
    - `minValue` number: Floor on the computed fee.
    - `maxValue` number: Cap on the computed fee.
    - `fixedValue` number: An amount always charged in addition to a percentage. e.g. for a fee of 3.5% + $0.5: amountType will be PERCENT, amount will be 3.5, and fixedValue will be 0.5.
  - `minFundingAmount` number, required: Minimum initial funding amount accepted when creating a card.
  - `minTopUpAmount` number, required: Minimum amount accepted for a top-up on an already-issued card.
  - `maxTopUpAmount` number, required: Maximum amount accepted for a top-up on an already-issued card.
  - `minimumBalance` number, required: Floor this provider requires the card's balance to never drop below (e.g. Miden requires $1 for onb-cards). A withdrawal that would breach this is rejected (400) - terminate the card instead to withdraw its full balance. Zero means the provider has no such requirement.

## Other responses

- `400`: Request could not be validated
- `401`: Client is not authorized to make request
- `403`: Expected permission is not available.
- `default`: Internal Server Error

## Changes

- **2026-09-22** `596ca42aa76f`: 3 breaking, 6 info
  - the `creationFee` response's property type changed from `number` to no type for status `200`
  - the `fundingFee` response's property type changed from `number` to no type for status `200`
  - the `withdrawalFee` response's property type changed from `number` to no type for status `200`
  - added `#/components/schemas/CardUsageFee` to the `creationFee` response property `allOf` list for the response status `200`
  - …5 more
- **2026-09-18** `e45a393a81eb`: 1 info
  - the response property `minimumBalance` became required for the status `200`
- **2026-09-17** `6aec1590a678`: 1 info
  - added the optional property `minimumBalance` to the response with the `200` status
- **2026-09-11** `5ff3e810d459`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nestechops/apis/onboard-external-api-gateway/changes/ledger/card-packages/:packageId/terms/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)