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).

🚧

Importante

Use este endpoint também para cancelar um cartão, o cancelamento é feito alterando o status para um valor irreversível como CanceledByCustomer, CanceledByEmitter, LostOrTheftCanceled etc.

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:

ScopeDescrição
card.updateConcede acesso para realizar atualizações no cartão.

Cabeçalhos (Headers)

NomeObrigatórioDescrição
api-versionSimVersão da API. Atualmente, 1.0.
AuthorizationSimToken Bearer.

Parâmetros da rota (Path)

NomeTipoObrigatórioDescrição
proxypathSimCódigo identificador do cartão (somente números).

Corpo da requisição (Body)

CampoTipoObrigatórioDescrição
statusstringSimNovo status. Veja a tabela de status alterados pelo parceiro.
passwordstringCondicionalSenha (4 dígitos). Obrigatório para CanceledByEmitter ou DeathCanceled.
updateCardBindedbooleanNãoIndica 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:

StatusCódigoDescrição
400127O proxy tem vínculo com outros cartões; um ou mais atrelados não foram encontrados.
400128Mesma descrição do 127 — o proxy tem vínculo com outros cartões; atrelados não foram encontrados.
403020O status atual não permite alterações para o perfil de usuário usado na requisição.
404002Cartão não encontrado.
406009O status atual não pode transacionar para o status informado.
406018O status atual não pode ser alterado por este método.
406021O cartão já está no status de destino informado.
409CARD_CANCELEDO cartão já foi cancelado permanentemente.

Eventos

Configure os webhooks para receber:

EventoDescrição
CARD_STATUS_WAS_MODIFIEDO status do cartão foi alterado.

Artigos relacionados



Did this page help you?

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados