Alteração de endereço
stable pré pós
O processo de entrega do cartão ao cliente pode ser interrompido devido a problemas relativos ao endereço do destinatário (mudança ou informações incorretas, por exemplo).
Nesses casos, num primeiro momento, o status do cartão constará como NotDeliverede poderá levar alguns dias até passar para Custody (em custódia), momento em que será possível solicitar a alteração de endereço por meio deste endpoint.
Importante
Somente será possível informar um novo endereço de entrega quando o cartão apresentar o status
Custody.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente tenha solicitado a emissão de um cartão físico, de um cartão múltiplo ou da segunda via de um cartão, e o cartão não tenha sido entregue por problemas relativos ao endereço;
- O status de entrega do cartão seja
Custody.
Requisição
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/Cards/{{proxy}}/tracking/address
--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/Cards/{{proxy}}/tracking/address' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{token}}'
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 alterar o status de 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 o seguinte campo:
| Nome | Tipo | Descrição |
|---|---|---|
proxy | path | Obrigatório. Código do cartão utilizado para localizá-lo no processo de entrega. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
zipcode | string | Obrigatório. O CEP deve ser nacional e conter oito dígitos. |
address | string | Obrigatório. Objeto que contém informações sobre o endereço do titular do cartão ao qual deve ser realizado a entrega. |
number | string | Obrigatório. Número do imóvel, com até 10 caracteres (se não existir, substitua por “S/N”). |
neighborhood | string | Obrigatório. Nome do bairro para nova entrega. |
complement | string | Complemento do endereço. |
city | string | Obrigatório. Nome da cidade para a entrega. Deve-se evitar acentos e outros caracteres especiais |
state | string | Obrigatório. Sigla do estado (UF) do novo endereço de entrega. Deve-se respeitar o formato proposto pela ISO 3166-2:BR. Exemplo: SP. |
country | string | Obrigatório. Serão aceitos apenas endereços em território nacional. Deve-se respeitar o formato proposto pela ISO 3166-1. Exemplo: BR. |
Resposta (Response)
O status code 201 indicará que o endereço foi alterado com sucesso.
Após realizar a alteração de endereço, é possível acompanhar o rastreio do cartão normalmente.
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 | Descrição |
|---|---|---|
| 400 | — | Não é possível alterar o endereço, pois o seu cartão não está em custódia. |
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 about 1 month ago