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
proxye oactivateCodedo 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:
| Scope | Descrição |
|---|---|
card.update | Concede acesso para realizar atualizações no cartão. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros
| Local | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Path | proxy | string | Sim | Código identificador do cartão (somente números). |
| Body | activateCode | string | Sim | Código de ativação (até 12 caracteres). |
| Body | password | string | Sim | Senha de uso do cartão (4 dígitos). |
AtençãoPara 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.
DicaPara simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Além dos erros comuns a todos os endpoints:
| Status | Código | Descrição |
|---|---|---|
| 400 | 015 | O 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. |
| 400 | 016 | Ocorre 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. |
| 400 | 103 | Ocorreu um ou mais erros indefinidos. |
| 404 | 002 | O cartão informado não foi encontrado. |
| 406 | 018 | O status atual não pode ser alterado por este método. |
| 406 | 221 | Documento do cliente não foi identificado ou está indisponível. |
| 409 | MAIN_CARD_CANCELLED | O cartão adicional não pode ser ativado porque o cartão titular está cancelado. |
| 409 | MAIN_CARD_BLOCKED | O cartão adicional não pode ser ativado porque o cartão titular está bloqueado. |
| 500 | 014 | Ocorreu um erro ao tentar armazenar os dados do cartão. |
Eventos
Configure os webhooks para receber:
| Evento | Descrição |
|---|---|
CARD_WAS_ISSUED | O cartão foi emitido. |
Artigos relacionados
Updated 23 days ago
Did this page help you?
