Endereços
Uma conta cartão pode possuir múltiplos endereços cadastrados. Esses endereços podem ser utilizados para fins cadastrais e também para operações relacionadas ao cartão, como a entrega de cartões físicos.
A entrega do cartão físico será feita sempre no endereço indicado como endereço de correspondência, ou seja, o endereço cadastrado com o campo mailingAddress como true.
ImportanteAntes de solicitar a emissão de um cartão físico, é necessário garantir que o endereço de correspondência esteja correto e atualizado.
Operações disponíveis
A gestão de endereços é realizada por meio de APIs específicas:
- Criar endereço: cadastra um novo endereço para uma conta
- Atualizar endereço: altera dados de um endereço existente
- Listar endereços: consulta os endereços vinculados a uma conta
- Buscar endereço: consulta um endereço específico
Tipos de endereço
O campo type indica o tipo do endereço cadastrado.
| Tipo | Descrição |
|---|---|
RESIDENTIAL | Endereço residencial |
COMMERCIAL | Endereço comercial |
OTHER | Outro tipo de endereço |
Criar um novo endereço para uma conta
A criação de endereço deve ser utilizada quando houver necessidade de cadastrar um novo endereço para a conta cartão.
Ao criar um endereço, é possível indicar se ele será utilizado como endereço de correspondência por meio do campo mailingAddress.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | Sim | Tipo do endereço. Valores aceitos: RESIDENTIAL, COMMERCIAL ou OTHER |
address | string | Sim | Logradouro do endereço |
number | string | Sim | Número do endereço. Caso não tenha número, informar "0" |
country | string | Sim | País do endereço |
neighborhood | string | Sim | Bairro do endereço |
city | string | Sim | Cidade do endereço |
state | string | Sim | Estado do endereço |
zipCode | string | Sim | Código postal/CEP |
mailingAddress | boolean | Sim | Indica se o endereço será utilizado como endereço de correspondência |
complementaryAddress | string | Não | Complemento do endereço |
AtençãoO campo
numberé obrigatório. Caso o endereço não tenha número, informe"0".
AtençãoQuando o endereço for indicado como endereço de correspondência (
mailingAddress = true), caracteres especiais e acentuações podem ser ajustados para evitar erros no processo de embossing do cartão físico.
Atualizar os dados de um endereço
A atualização de endereço permite alterar informações de um endereço já cadastrado.
No processo de atualização, é possível atualizar apenas endereços que possuem o campo mailingAddress como false. Caso contrário, será retornado erro na requisição.
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Tipo do endereço. Valores aceitos: RESIDENTIAL, COMMERCIAL ou OTHER |
address | string | Logradouro do endereço |
number | string | Número do endereço. Caso não tenha número, informar "0" |
country | string | País do endereço |
neighborhood | string | Bairro do endereço |
city | string | Cidade do endereço |
state | string | Estado do endereço |
zipCode | string | Código postal/CEP |
mailingAddress | boolean | Indica se o endereço será utilizado como endereço de correspondência |
complementaryAddress | string | Complemento do endereço |
active | boolean | Indica se o endereço permanece ativo |
Listar endereços de uma conta
A listagem permite consultar os endereços vinculados a uma conta cartão.
Essa operação pode ser utilizada para validar qual endereço está definido como correspondência antes da emissão de um cartão físico.
| Campo | Tipo | Descrição |
|---|---|---|
id | int | Identificador do endereço |
addressType | string | Tipo do endereço |
address | string | Logradouro do endereço |
number | string | Número do endereço |
neighborhood | string | Bairro do endereço |
city | string | Cidade do endereço |
state | string | Estado do endereço |
country | string | País do endereço |
zipCode | string | Código postal/CEP |
mailingAddress | boolean | Indica se é o endereço de correspondência |
complement | string | Complemento do endereço |
createdAt | string | Data de criação do endereço |
updatedAt | string | Data da última atualização |
active | boolean | Indica se o endereço está ativo |
Regras importantes
- Uma conta cartão pode possuir mais de um endereço cadastrado
- Não há endpoint para exclusão de endereço
- O endereço de entrega do cartão físico será o endereço definido como correspondência (
mailingAddress = true) - Antes de emitir um cartão físico, valide se o endereço de correspondência está correto
- Caso o endereço não possua número, o campo
numberdeve ser preenchido com"0"
Updated about 21 hours ago