8 - Usage Limits Management
Create Card Usage Limit
The Create Card Usage Limit method allows you to set spending limits for cards, providing greater control and security over expenses. This functionality enables businesses and financial institutions to customize card usage rules, applying general restrictions or specific limits to certain purchase categories.
With this method, you can:
- Control the maximum number of transactions per day
- Set a maximum amount per transaction
- Establish a daily total spending limit
- Restrict transactions to specific time periods
- Create personalized limits for cards linked to a Locker Account
How can limits be applied?
- General Limit (Type = 0) – Limits are applied directly to the card, without distinguishing purchase categories or linking to a Locker Account.
- Category and Locker Account Limit (Type = 1) – Allows setting exclusive rules for each card linked to a Locker Account, assigning specific spending limits to different purchase segments, identified by MCC codes.
This means that each card within a Locker Account can have its own unique rules, providing an advanced level of control and customization for businesses and fintechs managing multiple cards under the same structure.
This flexibility allows companies and financial institutions to implement intelligent spending policies, ensuring that cards are used according to each user's needs, with security and efficiency.
Example of requisition:
{
"Method": "CreateCardUsageLimit",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"Type": 1,
"LockerAccount": "123456",
"PurchaseRuleId": "1",
"IdentifierCard": "800015485",
"TimeLimits": {
"StartTime": "08:00",
"EndTime": "22:00"
},
"TransactionLimits": {
"MaxTransactionsPerDay": 10,
"MaxTransactionAmount": 5000,
"MaxTotalValue": 20000
}
}
{
"Success": "true",
"Message": "Método executado com sucesso.",
}
Field Descripition:
Field | Description | Type | Required |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
Type | Defines the type of limit: 0 (General) or 1 (By MCC category and Locker Account). | Integer | Yes |
LockerAccount | Identifier of the Locker Account associated with the card. (Required for Type 1) | String | Yes (Type 1) |
PurchaseRuleId | MCC code representing the purchase category to be limited. (Required for Type 1) | String | Yes (Type 1) |
IdentifierCard | Unique identifier of the card where the limit will be applied. | String | Yes |
TimeLimits | Defines the time period in which transactions are allowed. | Object | No |
StartTime | Starting time for allowed transactions (HH:mm). | String | No |
EndTime | Ending time for allowed transactions (HH:mm). | String | No |
TransactionLimits | Object defining transaction restrictions for the card or MCC category. | Object | Yes |
MaxTransactionsPerDay | Maximum number of transactions allowed per day. | Integer | No |
MaxTransactionAmount | Maximum amount allowed per transaction. | Integer | No |
MaxTotalValue | Maximum total spending allowed within the defined period. | Integer | No |
Update Card Usage Limit
The Update Card Usage Limit method updates a previously configured spending limit for a card or Locker Account. The new limit completely replaces the previous value, ensuring the update takes effect immediately.
This functionality allows you to modify daily transaction limits, maximum transaction amounts, total daily spending caps, and time-based restrictions.
Limits can be applied in two ways:
- General Limit (Type = 0) – Updates the card limit without distinguishing purchase categories or Locker Accounts.
- Category-Based Limit (Type = 1) – Updates specific limits for an MCC segment linked to the card within a Locker Account.
This ensures continuous flexibility and control, allowing adjustments as needed.
Example of requisition:
{
"Method": "UpdateCardUsageLimit",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"Type": 1,
"LockerAccount": "123456",
"PurchaseRuleId": "5812",
"IdentifierCard": "800015485",
"TransactionLimits": {
"MaxTransactionsPerDay": 15,
"MaxTransactionAmount": 7000,
"MaxTotalValue": 30000,
},
"TimeLimits": {
"StartTime": "06:00",
"EndTime": "20:00"
}
}
{
"Success": "true",
"Message": "Método executado com sucesso.",
}
Field Descripition:
Field | Description | Type | Required? |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
Type | Limit type: 0 (General) or 1 (By MCC and Locker Account). | Integer | Yes |
LockerAccount | Identifier of the Locker Account associated with the card. (Type = 1) | String | Yes (Type 1) |
PurchaseRuleId | MCC code of the purchase category to be updated. (Type = 1) | String | Yes (Type 1) |
IdentifierCard | Unique identifier of the card. | String | Yes |
TimeLimits | Defines the period in which transactions are allowed. | Object | No |
StartTime | Starting time for allowed transactions (HH:mm). | String | No |
EndTime | Ending time for allowed transactions (HH:mm). | String | No |
TransactionLimits | Object defining transaction restrictions. | Object | Yes |
MaxTransactionsPerDay | Maximum number of transactions per day. | Integer | No |
MaxTransactionAmount | Maximum amount allowed per transaction. | Integer | No |
MaxTotalValue | Maximum total spending allowed per day. | Integer | No |
Get Card Usage Limits
The Get Card Usage Limits method allows you to retrieve the spending limits applied to a card or Locker Account, including details on maximum allowed amounts and time restrictions.
This functionality provides transparency and control over each card’s usage rules, enabling financial institutions and businesses to monitor and manage limits efficiently.
Limits can be retrieved in two ways:
- Card-Based Query (Type = 0) – Returns general limits applied to a specific card.
- Locker Account-Based Query (Type = 1) – Returns limits applied to cards within a Locker Account, considering rules segmented by MCC.
Example of requisition:
{
"Method": "GetCardUsageLimits",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"Type": 1,
"IdentifierCard": null,
"LockerAccount": "123456"
}
{
"Success": true,
"Message": "Consulta realizada com sucesso",
"Result": {
"Type": 1,
"LockerAccount": "123456",
"TimeLimits": {
"StartTime": "06:00",
"EndTime": "20:00"
},
"TransactionLimits": {
"MaxTransactionsPerDay": 15,
"MaxTransactionAmount": 7000,
"MaxTotalValue": 30000
},
"MerchantLimits": [
{
"MerchantId": "987654321012345",
"LimitValue": 10000
}
]
}
}
Field Descripition:
Field | Description | Type | Required? |
---|---|---|---|
Method | API method to be invoked. | String | Yes |
PartnerId | Identifier of the partner making the request. | Integer | Yes |
BusinessUnitId | Identifier of the business unit associated with the partner. | Integer | Yes |
Type | Query type: 0 (By card) or 1 (By Locker Account). | Integer | Yes |
IdentifierCard | Card identifier to be queried (Required for Type 0). | String | Yes (Type 0) |
LockerAccount | Locker Account identifier to be queried (Required for Type 1). | String | Yes (Type 1) |
Updated 13 days ago