Guides
API Reference

Card Management

Suggest Edits

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.

🚧

Note:

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"  
}

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."  
}

Recharge Card

This method allows recharging an active card linked to a cardholder. In addition to immediate recharge, the method also supports scheduled recharges, which can be configured for specific dates, either one-time or recurring (For example, monthly). This provides flexibility for companies in managing benefits, ensuring that balances are credited automatically according to their policies.

Types of Recharge:

  • Immediate Recharge: The value is credited to the card 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 For example, monthly), ensuring benefit continuity.
{  
  "Method": "RechargeCard",  
  "PartnerId": 30326,  
  "BusinessUnitId": 30326,  
  "TaxNumber": "59626023821",  
  "RechargeValue": 50,  
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",  
  "PrepaidCardId": "800234100",  
  "PurchaseRuleId": 2  
}

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

Discharge Card

Used to remove a value from the card’s balance. This method is helpful in scenarios such as benefit returns or refunds.

{  
  "Method": "DischargeCard",  
  "PartnerId": 30326,  
  "BusinessUnitId": 30326,  
  "TaxNumber": "59626023821",  
  "DischargeValue": 50,  
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",  
  "PrepaidCardId": "800234100",  
  "PurchaseRuleId": 2  
}

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

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!"  
}

Updated about 1 month ago