Ativação do cartão

stable pré pós

Este endpoint possibilita a ativação de um cartão pela primeira vez, após o cliente recebê-lo.

Pré-requisitos

Antes de começar, certifique-se de que:

  • O cliente possui um cartão pendente de ativação, com status diferente de Building.
  • Você tem o proxy e o activateCode do cartão (retornados na emissão).
  • A requisição usa o scope card.update.

Requisição (Request)

Requisição HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/activate
     --request PATCH \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/activate' \
     --header 'Authorization: Bearer {{Token}}' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json' \
     --data '
{
     "activateCode": "string",
     "password": "8475"
}'

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)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros

LocalCampoTipoObrigatórioDescrição
PathproxystringSimCódigo identificador do cartão (somente números).
BodyactivateCodestringSimCódigo de ativação (até 12 caracteres).
BodypasswordstringSimSenha de uso do cartão (4 dígitos).
❗️

Atenção

Para maior segurança, oriente o cliente a não usar a senha atual nem datas de aniversário, e a evitar dígitos sequenciais (1234, 8765) ou repetidos (1111).

{
     "activateCode": "string",
     "password": "8475"
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e que a ativação foi realizada.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Além dos erros comuns a todos os endpoints:

StatusCódigoDescrição
400015O cartão informado não tem vínculo com nenhum outro cartão. Ocorre ao tentar ativar um cartão virtual, pois ele já nasce ativo.
400016Ocorre ao tentar ativar um cartão físico vinculado a um virtual. Para cartões panless, o proxy do cartão virtual deverá ser enviado.
400103Ocorreu um ou mais erros indefinidos.
404002O cartão informado não foi encontrado.
406018O status atual não pode ser alterado por este método.
406221Documento do cliente não foi identificado ou está indisponível.
409MAIN_CARD_CANCELLEDO cartão adicional não pode ser ativado porque o cartão titular está cancelado.
409MAIN_CARD_BLOCKEDO cartão adicional não pode ser ativado porque o cartão titular está bloqueado.
500014Ocorreu um erro ao tentar armazenar os dados do cartão.

Eventos

Configure os webhooks para receber:

EventoDescrição
CARD_WAS_ISSUEDO cartão foi emitido.

Artigos relacionados



Did this page help you?

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