Vinculação do cartão com uma conta bancária
stable pré
O cartão No Name somente é ativado quando vinculado a uma conta.
Após a criação desse vínculo, o seu cliente já poderá definir uma senha para o uso do cartão.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O parceiro tenha emitido pelo menos um lote de cartões;
- O cliente do parceiro possua uma conta ativa.
Requisição
Requisição HTTP
PATCH https://api-mtls.sandbox.bankly.com.br/cards/activateCode/{activateCode}/binding/
--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/activateCode/{activateCode}/binding/' \
--header 'Authorization: Bearer {token}' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--data '{
"password": "1234",
"bankAccount": "15164",
"bankAgency": "0001",
"documentNumber": "47742663023",
"alias": "N. Floresta"
} '
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 a realização de 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 da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
activateCode | path | Obrigatório. Código de ativação do cartão (12 caracteres). | Tamanho: 12 caracteres. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
password | string | Obrigatório. Senha para uso do cartão. | Informe uma senha com 04 dígitos. |
bankAccount | string | Obrigatório. Número da conta ao qual o cartão será vinculado. | — |
bankAgency | string | Obrigatório. Número da agência (quatro dígitos) do banco ao qual a conta pertence. | — |
documentNumber | string | Obrigatório. Número do documento (CPF ou CNPJ) do titular da conta. | Informe somente números. O tamanho máximo desse campo é de 14 caracteres. |
alias | string | Apelido do cartão que poderá auxiliar o cliente a identificá-lo no aplicativo. O alias não será impresso no cartão. | Não é permitido o uso de caracteres especiais e seu tamanho máximo é de 16 caracteres. |
{
"password": "1234",
"bankAccount": "15164",
"bankAgency": "0001",
"documentNumber": "47742663023",
"alias": "N. Floresta"
}
Resposta (Response)
O status code 200 indicará que o cartão foi vinculado à conta com sucesso.
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 |
|---|---|---|---|
| 406 | 018 | Current status does not allow changes by this method! | O status atual não pode ser alterado por este método. |
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 5 months ago