Ativação do cartão
stable pré pós
Após o recebimento do cartão, o cliente deverá realizar sua ativação.
Este endpoint possibilita que o cliente do parceiro Bankly ative seu cartão pela primeira vez.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro Bankly tenha um cartão e que o seu status seja diferente de "Building".
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 ativar um 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 da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
proxy | path | Obrigatório. Código identificador do cartão. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
activateCode | string | Obrigatório. Código de ativação do cartão. | Tamanho: 12 caracteres. |
password | string | Obrigatório. Senha de uso do cartão. | A senha deve possuir 04 dígitos. |
Atenção
Para maior segurança, recomendamos que o cliente do parceiro não utilize a senha atual e nem uma data de aniversário. A senha não deve conter números sequenciais (Ex. 1234 ou 8765) ou repetidos (Ex. 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
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | 015 | Card Not have bind! | O cartão informado não tem vínculo com nenhum outro cartão. Ocorre ao tentar ativar um cartão virtual, porque ele já nasce ativo. |
| 400 | 016 | Virtual card with problem in your bond! | 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 | One or more undefined errors happened! | Ocorreu um ou mais erros indefinidos. |
| 404 | 002 | Card not found! | O cartão informado não foi encontrado. |
| 406 | 018 | Current status does not allow changes by this method! | O status atual não pode ser alterado por este método. |
| 406 | 221 | The document could not found in company! | Documento do cliente não foi identificado ou o mesmo está indisponível. |
| 500 | 014 | Error has save events card! | Ocorrência de erro ao tentar armazenar os dados do cartão. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 15 days ago