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:

FieldDescriptionTypeRequired
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
TypeDefines the type of limit: 0 (General) or 1 (By MCC category and Locker Account).IntegerYes
LockerAccountIdentifier of the Locker Account associated with the card.
(Required for Type 1)
StringYes
(Type 1)
PurchaseRuleIdMCC code representing the purchase category to be limited. (Required for Type 1)StringYes (Type 1)
IdentifierCardUnique identifier of the card where the limit will be applied.StringYes
TimeLimitsDefines the time period in which transactions are allowed.ObjectNo
StartTimeStarting time for allowed transactions (HH:mm).StringNo
EndTimeEnding time for allowed transactions (HH:mm).StringNo
TransactionLimitsObject defining transaction restrictions for the card or MCC category.ObjectYes
MaxTransactionsPerDayMaximum number of transactions allowed per day.IntegerNo
MaxTransactionAmountMaximum amount allowed per transaction.IntegerNo
MaxTotalValueMaximum total spending allowed within the defined period.IntegerNo

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:

FieldDescriptionTypeRequired?
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
TypeLimit type: 0 (General) or 1 (By MCC and Locker Account).IntegerYes
LockerAccountIdentifier of the Locker Account associated with the card. (Type = 1)StringYes (Type 1)
PurchaseRuleIdMCC code of the purchase category to be updated. (Type = 1)StringYes (Type 1)
IdentifierCardUnique identifier of the card.StringYes
TimeLimitsDefines the period in which transactions are allowed.ObjectNo
StartTimeStarting time for allowed transactions (HH:mm).StringNo
EndTimeEnding time for allowed transactions (HH:mm).StringNo
TransactionLimitsObject defining transaction restrictions.ObjectYes
MaxTransactionsPerDayMaximum number of transactions per day.IntegerNo
MaxTransactionAmountMaximum amount allowed per transaction.IntegerNo
MaxTotalValueMaximum total spending allowed per day.IntegerNo

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:

FieldDescriptionTypeRequired?
MethodAPI method to be invoked.StringYes
PartnerIdIdentifier of the partner making the request.IntegerYes
BusinessUnitIdIdentifier of the business unit associated with the partner.IntegerYes
TypeQuery type: 0 (By card) or 1 (By Locker Account).IntegerYes
IdentifierCardCard identifier to be queried (Required for Type 0).StringYes (Type 0)
LockerAccountLocker Account identifier to be queried (Required for Type 1).StringYes (Type 1)