4 - Security and Access Control
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 |
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 |
Update Card Contactless
This method is used to enable or disable contactless card.
Example of requisition:
{
"Method": "UpdateCardContactless",
"BusinessUnitId": 40561,
"PartnerId": 20442,
"Allow": false,
"IdentifierCard": "800082367"
}
{
"Success": "true",
"Message": "Método executado 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 |
| Allow | Field that allows to turn Contactless on and off the card. | Bool | Yes |
Updated about 22 hours ago