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 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:

O cliente tenha solicitado a emissão de um cartão físico ou da segunda via de um cartão, e cartão não tenha sido entregue por problemas relativos ao endereço;
O status de entrega do cartão seja Custody.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Cards/changeDeliveryAddress/{proxy}

--request POST 'https://sandbox.hiperbanco.com.br/Cards/changeDeliveryAddress/{proxyy}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "zipCode": "70150900",
  "addressLine": "Rua 123",
  "buildingNumber": "12",
  "complement": "Apt. 102",
  "neighborhood": "Centro",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	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	Especificação
`proxy`	`path`	Obrigatório. Código identificador do cartão.	Insira somente números, sem caracteres especiais.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`zipCode`	`string`	Informe somente números. O CEP deve ser nacional e conter oito dígitos.
`addressLine`	`string`	Logradouro ou nome da rua.
`buildingNumber`	`string`	Número do imóvel.
`complement`	`string`	Informação complementar do endereço.
`neighborhood`	`string`	Bairro.
`city`	`string`	Evite acentos e outros caracteres especiais.
`state`	`string`	Formato ISO 3166-2:BR. Exemplo: SP.
`country`	`string`	Formato ISO 3166-2:BR. Exemplo: BR.

{
  "zipCode": "41341040",
  "addressLine": "Melo Rodovia",
  "buildingNumber": "6896",
  "complement": "",
  "neighborhood": "Gwynedd County",
  "city": "Lavínia do Descoberto",
  "state": "BA",
  "country": "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.

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 que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.