API Reference

5 - Creation, Update, Query and Transactions

Suggest Edits

GetCardHolders

This method is used to get cardholder data.

Request body

{
"Method": "GetCardHolders",
"PartnerId": 30326,
"BusinessUnitId": 30326
}

Responses

{
"Success": "true",
"Message": "ISI0001 - Método executado com sucesso",
"CardHolders": "[{"HolderTaxNumber":"06994676323",
"Nationality":"brasileiro","MotherName":"Maria de Lourdes",
"Gender":"Male","FullName":"Matheus Cavalcante",
"BirthDate":"03/11/1996 00:00:00","MaritalStatus":
"Married"},{"HolderTaxNumber":"61034135325","Nationality":"Brasileiro",
"MotherName":"Albaniza Santiago","Gender":"Male",
"FullName":"Victor Everton Santiago Barbosa",
"BirthDate":"17/08/1997 00:00:00","MaritalStatus":"Single"}]"
}

RechargeCard

This method is used to recharge the cardholder's card.

🚧

Note:

This method only works for cards in the per account mode.

Request body

{
"Method": "RechargeCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"TaxNumber": "59626023821",
"RechargeValue": 50,
"Identifier": "e64dc360-7692-483c-a242-91e7d533e1d7",
"PrepaidCardId": "800234100"
}

Responses

{
"Success": "true",
"Message": "ISI0179 - Solicitação de Recarga registrada com sucesso!",
"DocumentNumber": 93071543
}

DischargeCard

This method is used to discharge the card from the cardholder.

Note: The method works only for cards in the per account modality.

Request body

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

Responses

{
"Success": "true",
"Message": "ISI0180 - Descarga efetuada com sucesso!",
"DocumentNumber": 92448006
}

GetRechargeCard

This method is used to obtain the charge carried out on the cardholder's card.

Request body

{
"Method": "GetRechargeCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"DocumentNumber": 985547
}

Responses

{
"Success": "true",
"Message": "Método executado com sucesso.",
"DocumentNumber": 985547,
"Status": "Created",
"TotalValue": 120.5,
"CreationDate": "03/03/2022",
"IdentifierCard": "800015485"
}

GetDischargeCard

This method is used to obtain the discharge performed on the cardholder's card.

Request body

{
"Method": "GetDischargeCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"DocumentNumber": 985547
}

Responses

{
"Success": "true",
"Message": "Método executado com sucesso.",
"DocumentNumber": 985547,
"Status": "Created",
"TotalValue": 120.5,
"CreationDate": "03/03/2022",
"IdentifierCard": "800015485"
}

UpdateCardContactless

This method is used to enable or disable contactless card

Request Body

{ 

    "Method": "UpdateCardContactless", 
    "BusinessUnitId": 40561, 
    "PartnerId": 20442, 
    "Allow": false,  
    "IdentifierCard": "800082367" 
}

Response

{ 
    "Success": "true", 
    "Message": "Método executado com sucesso" 
}

Meaning of the fields:

Method (string): Name of the method that will be called.

PartnerId (long): Customer's credentials.

BusinessUnitId (long): Customer's credentials.

Allow (bool): Field that allows to turn Contactless on and off the card.

IdentifierCard (string): Identifier of the card (the 9 numbers on the back of the card).

Updated over 1 year ago