List Cards Limits - Field Descriptions (Product Level)

The following page details each of the fields received in the response when using the List Card Limits endpoint.

Response Fields

The following table describes fields that included in the response after successfully retrieving card limits.

FieldDescription
availableBalanceThe available balance of the card.
maxAllowableBalanceMaximum allowed balance of the card.
currencyCodeThe currency code for the card.
blockedAmountAmount of funds blocked on the card account as a result of all outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2).
cardLimitsObject that contains the cards limits associated with the card.
subGroupThe type of limit. This will be one of the following:
  • CASH
  • PAY_IN
  • PAY_OUT
  • POS
  • UNLOAD
  • LOAD
dailyObject that contains the period limits.
periodThe number of units in the period.
unitThe type of period unit. This will be either:
  • Hour
  • Day
  • Month
  • Year
limitThe total financial amount of the limit per period.
frequencyThe number of transactions allowed in the period.
usageThe current usage of total financial amount for the limit.
NoThe current usage of number of transactions in the period.
accumulatedPeriod1Object that contains details around accumulated period 1, set up during the implementation process.
periodThe length of period 1. Only used if Periodicity is set to Rolling Limits.
unitThe type of period unit. This will be either:
  • Hour
  • Day
  • Month
  • Year
limitAccumulated total value over period 1.
frequencyAccumulated number of transactions in period 1.
spentThe spend limit for period 1.
transactionCountThe transaction count limit for period 1.
accumulatedPeriod2Object that contains details around accumulated period 2, set up during the implementation process.
periodThe length of period 2. Only used if Periodicity is set to Rolling Limits.
unitThe type of period unit. This will be either:
  • Hour
  • Day
  • Month
  • Year
limitAccumulated total value over period 2.
frequencyAccumulated number of transactions in period 2.
spentThe spend limit for period 2.
transactionCountThe transaction count limit for period 2.