NEnestechops
ledger-card terms

Get a card package's terms.

Changed on

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).

get/ledger/card-packages/{packageId}/terms

Request

Path parameters

packageIdstring required

The card provider/package ID, from GET /card-packages (e.g. onb-cards).

Response

Card package terms fetched successfully

packageIdstring required
minFundingAmountnumber required

Minimum initial funding amount accepted when creating a card.

minTopUpAmountnumber required

Minimum amount accepted for a top-up on an already-issued card.

maxTopUpAmountnumber required

Maximum amount accepted for a top-up on an already-issued card.

minimumBalancenumber 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.

Example response

{
  "packageId": "onb-cards",
  "minimumBalance": 1
}

Changes

  • 596ca42aa76fRevision changes
    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the response's property type changed from number to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • e45a393a81ebRevision changes
    • info

      the response property became required for the status