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.

Example of requisition:

{
  "Method": "RechargeCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "PrepaidCardId": "800234100",
  "TaxNumber": "59626023821",
  "Bank": "001",
  "BankBranch": "0001",
  "BankAccount": "01241455",
  "BankAccountDigit": "1",
  "RechargeValue": 50,
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",
  "Description": "descrição da recarga",
  "Tags": "Cartão X",
  "PurchaseRuleId": 16,
  "ScheduleDate": "2024-09-26",
  "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
PrepaidCardId	Unique identifier of the prepaid card to be recharged.	String	Yes
TaxNumber	Tax number (e.g., CPF in Brazil) of the card owner.	String	Yes
Bank	Bank code where the recharge will be processed (e.g., 001 for Banco do Brasil).	String	Yes
BankBranch	Branch code of the bank where the recharge will be processed.	String	Yes
BankAccount	Bank account number of the cardholder where the recharge will be processed.	String	Yes
BankAccountDigit	Digit associated with the bank account number.	String	Yes
RechargeValue	Amount to be recharged to the prepaid card.	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	Yes
PurchaseRuleId	Identifier for the purchase rule associated with the recharge.	Integer	Yes
ScheduleDate	Date on which the recharge will be scheduled (format YYYY-MM-DD).	String	Yes
RecurringSchedule	Whether the recharge is recurring. Options:	Integer	Yes
	- 0 = no
	- 1 = yes

Discharge Card

Removes funds from a card, transferring the balance to the associated account or another authorized destination.

Example of requisition:

{
  "Method": "DischargeCard",
  "PartnerId": 30326,
  "BusinessUnitId": 30326,
  "TaxNumber": "59626023821",
  "Bank": "001",
  "BankBranch": "0001",
  "BankAccount": "01241455",
  "BankAccountDigit": "1",
  "DischargeValue": 50,
  "Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",
  "PrepaidCardId": "800234100",
  "Description": "descrição da recarga",
  "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
TaxNumber	Tax number (e.g., CPF in Brazil) of the card owner.	String	Yes
Bank	Bank code where the discharge will be processed (e.g., 001 for Banco do Brasil).	String	Yes
BankBranch	Branch code of the bank where the discharge will be processed.	String	Yes
BankAccount	Bank account number of the cardholder where the discharge will be processed.	String	Yes
BankAccountDigit	Digit associated with the bank account number.	String	Yes
DischargeValue	Amount to be discharged from the prepaid card.	Float	Yes
Identifier	Unique identifier for the discharge transaction.	String	Yes
PrepaidCardId	Unique identifier of the prepaid card from which the funds will be discharged.	String	Yes
Description	Description of the discharge transaction.	String	Yes
Tags	Tags associated with the discharge transaction (e.g., "Cartão X").	String	Yes
PurchaseRuleId	Identifier for the purchase rule associated with the discharge.	Integer	Yes

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