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é-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

Requisição (Request)

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:

ScopeDescrição
card.updateConcede acesso para alterar o status de um cartão.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

NomeTipoDescrição
proxypathObrigató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:

NomeTipoDescriçãoEspecificação
zipcodestringObrigatório. Código postal do endereço.O CEP deve ser nacional e conter oito dígitos.
addressstringObrigatório. Objeto que deverá conter informações sobre o endereço do titular do cartão ao qual deve ser realizado a entrega.
numberstringObrigatório. Número do imóvel (se não existir, substitua por “S/N”).Tamanho máximo de até 10 caracteres.
neighborhoodstringObrigatório. Nome do bairro para nova entrega.
complementstringComplemento do endereço.
citystringObrigatório. Nome da cidade para a entrega.Evite acentos e outros caracteres especiais.
statestringObrigatório. Sigla do estado (UF) do novo endereço de entrega.Formato ISO 3166-2:BR. Exemplo: SP.
countrystringObrigatório. Sigla do país, neste caso, "BR". Importante: serão aceitos apenas endereços em território nacional.Formato ISO 3166-2:BR. 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 CodeCódigoDescrição
400Nã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.


Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados