Alteração de endereço

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 NotDelivered e 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

Apenas quando o status passa para Custody é possível informar um novo endereço de entrega.

Endpoint

Para utilizar este endpoint, será necessário informar o proxy (código do cartão utilizado para localizá-lo no processo de entrega) no path da requisição do tipo POST.

--location --request POST https://api-mtls.sandbox.bankly.com.br/Cards/{{proxy}}/tracking/address' \ 
	    --header 'accept: application/json' \ 
	    --header 'api-version: 1' \
	    --header 'Authorization: Bearer {{token}}'

Body

Para informar um novo endereço de entrega são necessários os seguintes campos na requisição:

• zipcode: o CEP deve ser nacional e conter oito dígitos;
• address: nome do logradouro em que o cliente deseja receber o cartão;
• number: número do imóvel, em formato string, com até 10 caracteres (se não existir, substitua por “S/N”);
• neighborhood: bairro para nova entrega;
• complement (opcional): complemento do endereço;
• city: nome da cidade para a entrega. Deve-se evitar acentos e outros caracteres especiais;
• state: estado (UF) do novo endereço de entrega. Deve-se respeitar o formato proposto pela ISO 3166-2:BR. Exemplo: SP;
• country: serão aceitos apenas endereços em território nacional. Deve-se respeitar o formato proposto pela ISO 3166-1. Exemplo: BR.

Retorno

Ao cadastrar o novo endereço com sucesso será retornado o código 201.

📘

Nota

Após realizar a alteração de endereço, é possível acompanhar o rastreio do cartão normalmente.

Erros