Card Management

Create Card Purchase Rule

This method is used to link a specific purchase rule to an active card. The purchase rule defines the spending restrictions and permissions, such as spending category (For example, food, transportation) and allowed merchants.

📘

Important:

Rules are pre-defined and can only be linked to a card.

{  
  "Method": "CreateCardPurchaseRule",  
  "PartnerId": 30326,  
  "BusinessUnitId": 30326,  
  "IdentifierCard": 800015485,  
  "PurchaseRuleId": 1208  
}

{  
  "Success": "true",  
  "Message": "Rule 1208 successfully linked to card 800015485"  
}

Field Descripition

Unbind Card Purchase Rule

Used to remove a purchase rule previously linked to a card. Unlinking a purchase rule removes the specific restrictions associated with the rule.

{  
  "Method": "UnbindCardPurchaseRule",  
  "PartnerId": 30326,  
  "BusinessUnitId": 30326,  
  "IdentifierCard": 800015485,  
  "PurchaseRuleId": 1208  
}

{  
  "Success": "true",  
  "Message": "Rule successfully unlinked."  
}

Field Descripition

Recharge Card

This method allows recharging an active card linked to a cardholder or a Locker account. The method supports both immediate recharges and scheduled recharges, which can be set for specific dates, either one-time or recurring (for example, monthly). This provides flexibility for companies to manage benefits, ensuring that balances are credited automatically according to their policies.

Types of Recharge:

• Immediate Recharge: The value is credited to the card or Locker account as soon as the request is made.
• Scheduled Recharge (One-time): The recharge is scheduled for a specific future date.
• Recurring Recharge: The recharge is configured to occur repeatedly, ensuring benefit continuity (for example, monthly).

Example of requisition:

{
  "Method": "RechargeCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "Type": 1, 
  "PrepaidCardId": "800234100", 
  "LockerAccount": "54455464-4654645-564-56", 
  "RechargeValue": 50,
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",
  "Description": "recharge description",
  "Tags": "Card X",
  "PurchaseRuleId": 16,
  "ScheduleDate": "2024-09-26T00:00:00.000Z",
  "RecurringSchedule": 0
}

{  
  "Success": "true",  
  "Message": "ISI0179 - Recharge request successfully registered!",  
  "DocumentNumber": 93071543  
}

Field Descripition:

Discharge Card

This method allows the withdrawal of balance from a prepaid card or a Locker account. The withdrawal is processed immediately, and the value is deducted from the available balance in the associated card or Locker account. Flexibility is also provided for Locker accounts, allowing the operation to be performed without the need for a physical card.

Withdrawal Types:

• Card Withdrawal (Type = 0): The value is withdrawn from a prepaid card, identified by the PrepaidCardId.
• Locker Account Withdrawal (Type = 1): The value is withdrawn from a Locker account, identified by the LockerAccount.

Example of requisition:

{
  "Method": "DischargeCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "Type": 1, 
  "PrepaidCardId": "800234100",
  "LockerAccount": "54455464-4654645-564-56", 
  "RechargeValue": 50,
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",
  "Description": "descrição da retirada de saldo",
  "Tags": "Cartão X",
  "PurchaseRuleId": 16,
}

{
  "Success": "true",
  "Message": "ISI0180 - Discharge successfully completed!",
  "DocumentNumber": 92448006
}

Field Descripition:

Card Benefit Transfer

This method allows transferring values between different benefit rules (For example, from "Food" to "Transportation") within the card. It is useful for redistributing balances according to the user's needs.

{  
  "Method": "CardBenefitTransfer",  
  "PartnerId": 30326,  
  "BusinessUnitId": 30326,  
  "IdentifierCard": 800015485,  
  "BenefitFrom": 1208,  
  "BenefitTo": 1306,  
  "Value": 589.89,  
  "Identifier": "5ede542f-a7c4-4afb-9b63-129b8422d470"  
}

{  
  "Success": "true",  
  "Message": "Transfer successfully completed!"  
}

Field Descripition