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.
Field | Description |
---|---|
availableBalance | The available balance of the card. |
maxAllowableBalance | Maximum allowed balance of the card. |
currencyCode | The currency code for the card. |
blockedAmount | Amount 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). |
cardLimits | Object that contains the cards limits associated with the card. |
subGroup | The type of limit. This will be one of the following:
|
daily | Object that contains the period limits. |
period | The number of units in the period. |
unit | The type of period unit. This will be either:
|
limit | The total financial amount of the limit per period. |
frequency | The number of transactions allowed in the period. |
usage | The current usage of total financial amount for the limit. |
No | The current usage of number of transactions in the period. |
accumulatedPeriod1 | Object that contains details around accumulated period 1, set up during the implementation process. |
period | The length of period 1. Only used if Periodicity is set to Rolling Limits. |
unit | The type of period unit. This will be either:
|
limit | Accumulated total value over period 1. |
frequency | Accumulated number of transactions in period 1. |
spent | |
transactionCount | |
accumulatedPeriod2 | Object that contains details around accumulated period 2, set up during the implementation process. |
period | The length of period 2. Only used if Periodicity is set to Rolling Limits. |
unit | The type of period unit. This will be either:
|
limit | Accumulated total value over period 2. |
frequency | Accumulated number of transactions in period 2. |
spent | |
transactionCount |
Updated about 1 month ago