6 - Card Credit
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 - Solicitação de Recarga registrada com sucesso!",
"DocumentNumber": 93071543
}
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 | Type of recharge request. Options: | Integer | Yes |
- 0 = card identifier (PrepaidCardId) | |||
- 1 = Locker account (LockerAccount) | |||
PrepaidCardId | Unique identifier of the prepaid card to be recharged. | String | Yes (if Type = 0) |
LockerAccount | Unique identifier of the Locker account to be recharged. | String | Yes (if Type = 1) |
RechargeValue | Amount to be recharged to the prepaid card or Locker account. | Float | Yes |
Identifier | Unique identifier for the recharge transaction. | String | Yes |
Description | Description of the recharge transaction. | String | Yes |
Tags | Tags associated with the recharge transaction (e.g., "Cartão X"). | String | No |
PurchaseRuleId | Identifier for the purchase rule associated with the recharge. | Integer | No |
ScheduleDate | Date on which the recharge will be scheduled (format YYYY-MM-DD). | String | No |
RecurringSchedule | Whether the recharge is recurring. Options: | Integer | No |
- 0 = no | |||
- 1 = yes (recurring) |
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 - Descarga efetuada com sucesso!",
"DocumentNumber": 92448006
}
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 | Type of discharge request. Options: | Integer | Yes |
- 0 = card identifier (PrepaidCardId) | |||
- 1 = Locker account (LockerAccount) | |||
PrepaidCardId | Unique identifier of the prepaid card to have balance discharged. | String | Yes (if Type = 0) |
LockerAccount | Unique identifier of the Locker account to have balance discharged. | String | Yes (if Type = 1) |
RechargeValue | Amount to be discharged from the prepaid card or Locker account. | Float | Yes |
Identifier | Unique identifier for the discharge transaction. | String | Yes |
Description | Description of the discharge transaction. | String | No |
Tags | Tags associated with the discharge transaction (e.g., "Card X"). | String | No |
PurchaseRuleId | Identifier for the purchase rule associated with the discharge. | Integer | No |
Get Recharge Card
Retrieves details of top-ups made to a card, including amounts, dates, and operation statuses.
Example of requisition:
{
"Method": "GetRechargeCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"DocumentNumber": 985547
}
{
"Success": "true",
"Message": "Método executado com sucesso.",
"DocumentNumber": 985547,
"Status": "0",
"TotalValue": 120.5,
"CreationDate": "03/03/2022",
"IdentifierCard": "800015485"
}
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 |
IdentifierCard | Unique identifier of the card for which the recharge information is requested. | String | Yes |
DocumentNumber | Document number (e.g., CPF or CNPJ) of the cardholder associated with the card. | String | Yes |
Get Discharge Card
Retrieves details of top-ups made to a card, including amounts, dates, and operation statuses.
Example of requisition:
{
"Method": "GetDischargeCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"DocumentNumber": 985547
}
{
"Success": "true",
"Message": "Método executado com sucesso.",
"DocumentNumber": 985547,
"Status": "0",
"TotalValue": 120.5,
"CreationDate": "03/03/2022",
"IdentifierCard": "800015485"
}
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 |
IdentifierCard | Unique identifier of the card for which the discharge information is requested. | String | Yes |
DocumentNumber | Document number (e.g., CPF or CNPJ) of the cardholder associated with the card. | String | Yes |
Updated about 14 hours ago