Alteração do status do cartão
stable pré pós
Permite ao cliente do parceiro (ou ao próprio parceiro, em casos como fraude ou inadimplência) alterar o status de um cartão. O cartão pode passar para um status temporário (reversível) ou definitivo (irreversível).
ImportanteUse este endpoint também para cancelar um cartão, o cancelamento é feito alterando o status para um valor irreversível como
CanceledByCustomer,CanceledByEmitter,LostOrTheftCanceledetc.
Pré-requisitos
- O cliente tem um cartão com status diferente de
Building.
Veja a tabela completa de status para os valores aceitos.
Requisição (Request)
Requisição HTTP
PATCH https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/status --request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/status' \
--header 'Authorization: Bearer {{Token}}' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
--header 'content-type: application/json' \
--data '
{
"status": "TemporarilyUserLocked",
"password": "8457",
"updateCardBinded": false
}'Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
card.update | Concede acesso para realizar atualizações no cartão. |
Cabeçalhos (Headers)
| Nome | Obrigatório | Descrição |
|---|---|---|
api-version | Sim | Versão da API. Atualmente, 1.0. |
Authorization | Sim | Token Bearer. |
Parâmetros da rota (Path)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
proxy | path | Sim | Código identificador do cartão (somente números). |
Corpo da requisição (Body)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
status | string | Sim | Novo status. Veja a tabela de status alterados pelo parceiro. |
password | string | Condicional | Senha (4 dígitos). Obrigatório para CanceledByEmitter ou DeathCanceled. |
updateCardBinded | boolean | Não | Indica se o cartão vinculado deve ser atualizado junto. |
Os seguintes status podem ser informados sem o campo password: Active, TemporarilyUserLocked, CanceledByCustomer, LostOrTheftCanceled, CardDamagedCanceled, CardBrokenCanceled, CardWithDefectCanceled, RobbedCanceled.
{
"status": "TemporarilyUserLocked",
"password": "8457",
"updateCardBinded": false
}Resposta
Status: 200 OK — status alterado com sucesso. Sem corpo de resposta.
Erros
Além dos erros comuns a todos os endpoints:
| Status | Código | Descrição |
|---|---|---|
| 400 | 127 | O proxy tem vínculo com outros cartões; um ou mais atrelados não foram encontrados. |
| 400 | 128 | Mesma descrição do 127 — o proxy tem vínculo com outros cartões; atrelados não foram encontrados. |
| 403 | 020 | O status atual não permite alterações para o perfil de usuário usado na requisição. |
| 404 | 002 | Cartão não encontrado. |
| 406 | 009 | O status atual não pode transacionar para o status informado. |
| 406 | 018 | O status atual não pode ser alterado por este método. |
| 406 | 021 | O cartão já está no status de destino informado. |
| 409 | CARD_CANCELED | O cartão já foi cancelado permanentemente. |
Eventos
Configure os webhooks para receber:
| Evento | Descrição |
|---|---|
CARD_STATUS_WAS_MODIFIED | O status do cartão foi alterado. |
Artigos relacionados
Updated about 2 months ago
