Set Card Limits (Card Level)
The Set Card limits endpoint enables you to update the velocity limits of a Thredd card. This will override the default limits set up at a product level for your cards.
You can update the following limit categories:
- POS — Point Of Sales transaction limit. ( POS-Contactless — Contactless limit for all contactless POS transactions — is a sub-category of the POS limit category. )
- Cash — ATM transactions.
- Pay-In — Bank to Bank inward Payments. Only applicable if the client has opted for Thredd Agency Banking product.
- Pay-Out — Bank to Bank outward Payments. Only applicable if the client has opted for Thredd Agency Banking product.
Important!
- When the card limits are updated using Set Card Limits API, then Thredd uses this updated limit during transaction validation and this limit will always override the default product limits.
- For clients in regions where the Second Payment Directive (PSD2) Rules apply, Thredd will run additional PSD2 validation checks on the transaction, which may impact on the maximum allowed transaction limits. For more information, refer to the PSD2 Guide.
How to set card limits
- Retrieve the default card product limits by making a GET request to the Card Limits endpoint. See Get Card Limits.
- Set the card's limits by making a SET request to the Set Card Limits endpoint. For example:
https://cards-iapi-limits.uat.thredd.cloud/set_limitRequest Fields
The table below lists the fields in the Set Limits request.
Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
public_token | The card’s public token. | Number | 9 | 9 | Yes |
category | Categories are: • POS • Cash • Pay-In •Pay-Out | String | Yes | ||
subcategory | Subcategories are: Contactless (Applicable only for POS category) | String | No | ||
maximumpertransaction | The maximum allowable spend or load for each transaction. | Decimal | 1 | (14,4) | Yes |
minimumpertransaction | The minimum allowable spend or load for each transaction. | Decimal | 1 | (14,4) | Yes |
dailylimit | The maximum amount that can be spent or loaded within a single calendar day. | Decimal | 1 | (14,4) | Yes |
dailyfrequency | The maximum number of transactions or loads permitted within a single calendar day. | Integer | 1 | 10 | Yes |
accumlimit1 | The first accumulated limit allowed over the accumulated period defined in accumperiod1. For example, if the accumulated limit for a POS is set at 15,000 and the accumulation period is defined as 30 days, the cardholder will be permitted to spend a maximum of 15,000 within that 30-day timeframe. | Decimal | 1 | (14,4) | Yes |
accumfrequency1 | The maximum number of transactions or loads permitted within the first accumulation period. The number of days in the accumulation period is determined by the value of accumperiod1. For example, if the accumulated frequency for POS transactions is set to 100 and the accumperiod1 is established at 30 days, the cardholder will be limited to a maximum of 100 POS transactions within that 30-day timeframe. | Integer | 1 | 10 | Yes |
accumperiod1 | The first date range over which the accumulated limit applies. For example, if the accumulated period is configured to 30 days, the limits defined in accumfrequency1 and accumlimit1 will be applicable for a 30-day duration. | Integer | 1 | 4 | Yes |
accumlimit2 | The second accumulated limit allowed over the accumulated period defined in accumperiod2. | Decimal | 1 | (14,4) | Yes |
accumfrequency2 | The maximum number of transactions or loads permitted within the accumulation period. The number of days in the accumulation period is determined by the value of accumperiod2. | Integer | 1 | 10 | Yes |
accumperiod2 | The second date range over which the accumulated limit applies. For example, if the second accumulated period is configured to 365 days, the limits defined in accumfrequency2 and accumlimit2 will be applicable for that entire 365-day duration. | Integer | 1 | 4 | Yes |
Note:
- “null” and "0" values are not permitted for any of the fields in the request. In cases where the cardholder wants to set the limit for their contactless transactions to 0 (effectively 'turning off' contactless transactions), you can set the limit via API to a low amount, such as 0.0001, 0.001, 0.01, etc.
- To retrieve details of the card-specific limits for card, see Get Card Limits (Card-specific).
- To retrieve details of the card's product-level limits, see Get Card Limits (Product-level).
Below is an example of a Set Limit request.
{
"category_limits": [
{
"limits":
{
"dailyfrequency": 10,
"dailylimit": 200,
"accumfrequency1": 100,
"maximumpertransaction": 100,
"accumlimit2": 2000,
"accumperiod2": 365,
"accumlimit1": 800,
"accumperiod1": 30,
"minimumpertransaction": 0,
"accumfrequency2": 300
},
"category":"Cash"
},
{
"limits":
{
"dailyfrequency": 10,
"dailylimit": 200,
"accumfrequency1": 100,
"maximumpertransaction": 100,
"accumlimit2": 2000,
"accumperiod2": 365,
"accumlimit1": 800,
"accumperiod1": 30,
"minimumpertransaction": 0,
"accumfrequency2": 300
},
"category": "Pay_in"
},
{
"limits":
{
"dailyfrequency": 10,
"dailylimit": 200,
"accumfrequency1": 100,
"maximumpertransaction": 100,
"accumlimit2": 2000,
"accumperiod2": 365,
"accumlimit1": 800,
"accumperiod1": 30,
"minimumpertransaction": 0,
"accumfrequency2": 300
},
"category": "Pay_out"
},
{
"subcategories": [
{
"limits":
{
"dailyfrequency": 10,
"dailylimit": 200,
"accumfrequency1": 100,
"maximumpertransaction": 100,
"accumlimit2": 2000,
"accumperiod2": 365,
"accumlimit1": 800,
"accumperiod1": 30,
"minimumpertransaction": 0,
"accumfrequency2": 300
},
"subcategory": "Contactless"
}
],
"limits":
{
"dailyfrequency": 10,
"dailylimit": 200,
"accumfrequency1": 100,
"maximumpertransaction": 100,
"accumlimit2": 2000,
"accumperiod2": 365,
"accumlimit1": 800,
"accumperiod1": 30,
"minimumpertransaction": 0,
"accumfrequency2": 300
},
"category": "POS"
}
],
"public_token": 666612345
}Response Fields
If successful, a 200 response is returned. See the table below for possible response status values:
| Status code | Response Description |
|---|---|
| 200 | Limit set successfully. |
| 401 | Please provide an auth token as part of the request. |
| 401 | The provided auth token is not valid. Please request a new token and try again. |
| 403 | Access to openapi documentation is forbidden in the production environment. |
More Information
To view the endpoint in the API Explorer, see Set Card Limits.
Updated about 18 hours ago