3 - Card Management
Cancel Card
Permanently cancels a card, preventing its future use. Ideal for cases of loss, theft, or card obsolescence.
Example of requisition:
{
"Method": "CancelCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"Pin": "MTIzNA=="
}
{
"Success": "true",
"Message": "Sua solicitação de cancelamento foi salva com sucesso. O processo levará alguns minutos para ser concluído."
}
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 to be canceled. | String | Yes |
Pin | PIN encoded in Base64 format, required to authenticate the cancellation. | String | Yes |
Important:
How the CancelCard Method Works:
- Eligibility for Cancellation:
- The card cannot have a CardStatus of:
- PreCreated = 10
- Canceled = 11
- Allowed Card Status for Cancellation:
- The following CardStatus values are valid for initiating the cancellation process:
- Active = 4
- Generated = 2
- CancellationError = 13
- Bound = 3
- Binding = 8
- ErrorBinding = 5
- Special Condition for Active Cards:
- If the card has a CardStatus of Active = 4 and a UsageType of Balance (Balance Control by Payment), the process cannot proceed if the card balance is greater than zero.
Inactivate And Reissue Card
Deactivates an existing card and issues a replacement, preserving the balance and associated information.
Important:
- The new "IdentifierCard" generated during reissue must be used in the ActivateCard and ChangePinCard flow. This applies to both nominal and non-nominal cards.
- To use this method, the customer must provide the current card password (PIN).
Example of requisition:
{
"Method": "InactivateAndReissueCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"IdentifierProduct": "FC0000001",
"Pin": "MTIzNA==",
"ReasonCode": "4",
"CardDeliveryAddress": {
"Line": "Av José Bastos",
"Number": "4140",
"Complement": "AP 303",
"Reference": "Ao lado da JM Veículos",
"Neighborhood": "Rodolfo Teófilo",
"ZipCode": "60431086",
"City": "Fortaleza",
"State": "CE",
"Country": "Brasil"
}
}
{
"Success": "true",
"Card": "800015485",
"Message": "Solicitação de reemisão de cartão registrada com sucesso!"
}
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 to be inactivated and reissued. | String | Yes |
IdentifierProduct | Product code associated with the new card. | String | Yes |
Pin | PIN encoded in Base64 format, required to authenticate the request. | String | No |
ReasonCode | Code indicating the reason for inactivation and reissuance. Options: | String | Yes |
Lost card (Lost) = 2 | |||
Stolen card (Stolen) = 3 | |||
Card lost or delivery failed (FailureOrLossOnDelivery) = 4 | |||
Card suspended due to suspected fraud (SuspectedFraud) = 5 | |||
Card cancellation (Cancellation) = 6 | |||
CardDeliveryAddress | Object containing the delivery address for the reissued card. | Object | Yes |
├ Line | Street name of the delivery address. | String | Yes |
├ Number | Number of the delivery address. | String | Yes |
├ Complement | Additional details about the delivery address (e.g., apartment number). | String | No |
├ Reference | Reference point for the delivery address. | String | No |
├ Neighborhood | Neighborhood of the delivery address. | String | Yes |
├ ZipCode | ZIP code of the delivery address. | String | Yes |
├ City | City of the delivery address. | String | Yes |
├ State | State of the delivery address. | String | Yes |
├ Country | Country of the delivery address. | String | Yes |
Change Pin Card
Enables the security PIN of a card to be changed, enhancing protection against unauthorized access.
Important:
The current PIN is required to make the change.
Example of requisition:
{
"Method": "ChangePinCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"CurrentPin": "NDAyNw==",
"Pin": "MTIzNA==",
"PinCheck": "MTIzNA=="
}
{
"Success": "true",
"Message": "Solicitação de alteração de senha registrada com sucesso!"
}
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 PIN is being changed. | String | Yes |
CurrentPin | Current PIN encoded in Base64 format, used for authentication. | String | Yes |
Pin | New PIN encoded in Base64 format, to be set for the card. | String | Yes |
PinCheck | Confirmation of the new PIN, encoded in Base64 format. Must match Pin. | String | Yes |
Reset Pin Card
Resets a card's PIN to its default setting, allowing the cardholder to set a new code.
Importante:
The current PIN is not required to perform the reset.
Example of requisition:
{
"Method": "ResetPinCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"DateOfBirth": "1992/20/02"
}
{
"Success": "true",
"Message": "Solicitação de alteração de senha registrada com sucesso!"
}
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 PIN is being reset. | String | Yes |
DateOfBirth | Cardholder's date of birth in the format YYYY/DD/MM, used for verification. | String | Yes |
Block Card
Temporarily blocks a card, preventing its use until it is unblocked. Ideal for security purposes.
Example of requisition:
{
"Method": "BlockCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"Pin": "MTIzNA==",
"ReasonCode": "4"
}
{
"Success": "true",
"Message": "Solicitação de bloqueio registrada com sucesso!"
}
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 to be blocked. | String | Yes |
Pin | PIN encoded in Base64 format, required for authentication. | String | No |
ReasonCode | Code indicating the reason for blocking the card. | String | Yes |
- Lost card (Lost) = 2 | |||
- Stolen card (Stolen) = 3 | |||
- Card lost on delivery or failed delivery (FailureOrLossOnDelivery) = 4 | |||
- Card suspended for fraud (SuspectedFraud) = 5 | |||
- Card cancellation ( Cancellation ) = 6 | |||
- Card temporary block (TemporaryBlock)= 8 |
Unblock Card
Unblocks a previously blocked card, restoring its normal functionality.
Important:
This method can only be used if reason code 8 is provided in the BlockCard method.
Example of requisition:
{
"Method": "UnblockCard",
"PartnerId": 30326,
"BusinessUnitId": 30326,
"IdentifierCard": "800015485",
"Pin": "MTIzNA=="
}
{
"Success": "true",
"Message": "Solicitação de desbloqueio registrada com sucesso!"
}
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 to be unblocked. | String | Yes |
Pin | PIN encoded in Base64 format, required for authentication. | String | Yes |
Updated 8 days ago