Configuração do contactless
Ativar ou desativar a funcionalidade de pagamento por aproximação (contactless) para uso presencial.
Para ativar ou desativar o pagamento por aproximação do cartão, o status do cartão deve ser do tipo Ativo ou Bloqueio temporário. (Para obter informações sobre os tipos de status, consulte aqui)
Request
ENDPOINT
/prepaid/card/CARD_KEY/contactlessMÉTODO
PATCHPath params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
CARD_KEY * | string | Chave de identificação do cartão. | uuid |
Request Body
{
"contactless_enabled": false
}
Body params
Campo | Tipo | Descrição | Caracteres |
---|---|---|---|
contactless_enabled * | Boolean | Indica se está habilitado ou não. | true/false |
Response
STATUS SUCCESS
200Erros
STATUS
4XXResponse Body
{
"title": "Bad Request",
"description": "We're sorry, but the card could not be update contactless. Please try again later.",
"translation": "Unexpected error update contactless card",
"code": "CARD000026"
}
Código | Status code | Descrição |
---|---|---|
QIT000001 | 400 | Invalid Json schema. |
CARD000011 | 404 | It was not possible to fetch the Card for the card_key {card_key}. |
CARD000023 | 406 | The card type is invalid for this operation. Only plastic cards are allowed. |
CARD000026 | 400 | We're sorry, but the card could not be update contactless. Please try again later. |
CARD000025 | 406 | The status {status} is invalid for the operation. |
Webhook
WEBHOOK_TYPE
baas.prepaid_card.card.updated.contactlessWebhook Body
{
"webhook_type": "baas.prepaid_card.card.updated.contactless",
"event_datetime": "2023-07-25T12:00:00.000Z",
"data": {
"card_key": "9bd93e97-bb6d-410f-8981-06b2765f12a1",
"contactless_enabled": true
}
}