NEnestechops
ledger-card terms

List available card packages.

Changed on

Lists the card provider "packages" a business can create a card against, each with its current fee schedule embedded. Only onb-cards is registered today - a package appears here purely by registering another CardProviderService bean, with no change to this endpoint. The root path is /card-packages (not nested under /terms) to avoid stuttering, but sibling package-scoped resources (e.g. requirements, terms-of-service acceptance) can still be added as sub-resources later without a breaking restructure.

Each package also embeds the calling business's lifetime card-creation limit (lifetimeLimit) - the same figure across every package in the list, since the cap applies to the business across all providers combined, not per package.

get/ledger/card-packages

Request

Response

Card packages fetched successfully

Example response

{
  "packages": [
    {
      "id": "onb-cards",
      "currency": "USD",
      "fees": {
        "packageId": "onb-cards",
        "minimumBalance": 1
      },
      "lifetimeLimit": {
        "limit": 10,
        "currentCount": 3,
        "remaining": 7
      }
    }
  ]
}

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