Cria um novo endereço para uma conta
Uma conta pode ter mais de um endereço cadastrado, além da possibilidade de atualizar os endereços existentes.
É importante se atentar de que a entrega do cartão será feita sempre no último endereço de correspondência cadastrado (também denominado endereço da Conta Cartão), ou seja, durante sua jornada de solicitação de um novo cartão físico, atente-se a confirmação com usuário de que o último endereço de correspondência informado é o utilizado para a entrega e, caso não seja, realize uma atualização antes de solicitar a emissão.
Há duas funcionalidades relacionadas ao endereço de uma conta:
- Cria um novo endereço para uma conta
- Atualiza os dados de um endereço
Não há endpoint para exclusão de um endereço cadastrado anteriormente.
Passos para Integrar
- Realizar autenticação na API.
- Realizar a criação de um novo endereço ou atualização de informações.
Criar um novo endereço para uma conta
Para criar um novo endereço para uma conta, faça a seguinte chamada:
cURL da chamada
'{
"address": "Rua 20",
"number": "13",
"country": "BRA",
"complementary_address": "Próximo a praça",
"neighborhood": "Farolândia",
"city": "Aracaju",
"state": "SE",
"zip_code": "49100000",
"mailing_address": false,
"type": "RESIDENTIAL"
}'
Sucesso 200
Significado dos Campos
| Campos (obrigatórios) | Tipo | Descrição |
|---|---|---|
| type | char | RESIDENTIAL para residencial, COMMERCIAL para comercial ou OTHER |
| adress | string (50) | Nome da rua ou avenida |
| number | string (10) | Numero do local |
| country | string (20) | Pais em que se encontra o endereço |
| neighborhood | string (20) | Bairro em que se encontra o endereço |
| city | string (2) | Cidade em que se encontra o endereço |
| state | string (3) | Estado em que se encontra o endereço |
| zip_code | string (10) | Código de Endereçamento Postal (CEP) |
| mailling_adress | boolean | Indica se é o endereço de correspondência (entrega dos cartões). TRUE para indicar que é o endereço de correspondência ou FALSE para indicar que não é um endereço de correspondência |
| complementary_address | string (30) | Complemento do endereço |
{
"version": "1.0.0",
"status": 201,
"body": [
{
"enderecoId": 59,
"tipoEndereco": "R",
"endereco": "Rua 15",
"numero": "13",
"bairro": "Farolândia",
"cidade": "Aracaju",
"estado": "SE",
"pais": "BRA",
"cep": "49100000",
"enderecoCorrespondencia": false,
"complemento": "Próximo a praça",
"dataCriacao": "2024-06-04T13:29:31.000000Z",
"dataAtualizacao": "2024-06-04T15:22:37.000000Z",
"ativo": false
}
]
Significado dos Campos
| Campo | Tipo | Descrição |
|---|---|---|
| endercoId | int | Id do endereço gerado na criação da conta ou criação do endereço |
| tipoEndereco | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| endereco | string (50) | Nome da rua ou avenida |
| numero | string (10) | Numero do endereço |
| bairro | string (20) | Bairro em que se encontra o endereço |
| cidade | string (20) | Cidade em que se encontra o endereço |
| estado | string (2) | Estado em que se encontra o endereço |
| pais | string (3) | Pais em que se encontra o endereço |
| cep | string (10) | Código de Endereçamento Postal |
| enderecoCorrespondencia | boolean | Indica se é o endereço de correspondência (entrega dos cartões). TRUE para indicar que é o endereço de correspondência ou FALSE para indicar que não é um endereço de correspondência |
| complemento | string (30) | Complemento do endereço |
| dataCriacao | string (50) | Data em que foi cadastrado este endereço |
| dataAtualizacao | string (50) | Data da ultima atualização do endereço |
| ativo | boolean | Se este endereço permanece ativo ou desativado |
Atualizar os dados de um endereço
Para atualizar um endereço cadastrado, pode-se alterar o endereço completo ou apenas uma parte do endereço. Envie a seguinte requisição, com os campos a serem atualizados:
cURL da chamada
curl -X 'PATCH' \
'https://kubernetes-prod.celcoin.dev/api/accounts/1/address/1' \
-H 'accept: application/json' \
-H 'Client-Id: 1' \
-H 'Content-Type: application/json' \
-d '{
"address": "Rua 20",
"number": "13",
"country": "BRA",
"complementary_address": "Próximo a praça",
"neighborhood": "Farolândia",
"city": "Aracaju",
"state": "SE",
"zip_code": "49100000",
"mailing_address": false,
"type": "RESIDENTIAL",
"active": false
}'
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": [
{
"enderecoId": 59,
"tipoEndereco": "R",
"endereco": "Rua 15",
"numero": "13",
"bairro": "Farolândia",
"cidade": "Aracaju",
"estado": "SE",
"pais": "BRA",
"cep": "49100000",
"enderecoCorrespondencia": false,
"complemento": "Próximo a praça",
"dataCriacao": "2024-06-04T13:29:31.000000Z",
"dataAtualizacao": "2024-06-04T15:22:37.000000Z",
"ativo": false
}
]
}
Para atualizar apenas a apenas uma parte do endereço, envie a seguinte requisição para atualizar todos os dados do endereço:
Significado dos Campos
| Campo | Tipo | Descrição |
|---|---|---|
| endercoId | int | Id do endereço gerado na criação da conta ou criação do endereço |
| tipoEndereco | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| endereco | string (50) | Nome da rua ou avenida |
| numero | string (10) | Numero do endereço |
| bairro | string (20) | Bairro em que se encontra o endereço |
| cidade | string (20) | Cidade em que se encontra o endereço |
| estado | string (2) | Estado em que se encontra o endereço |
| pais | string (3) | Pais em que se encontra o endereço |
| cep | string (10) | Código de Endereçamento Postal |
| enderecoCorrespondencia | boolean | Indica se é o endereço de correspondência (entrega dos cartões). TRUE para indicar que é o endereço de correspondência ou FALSE para indicar que não é um endereço de correspondência |
| complemento | string (30) | Complemento do endereço |
| dataCriacao | string (50) | Data em que foi cadastrado este endereço |
| dataAtualizacao | string (50) | Data da ultima atualização do endereço |
| ativo | boolean | Se este endereço permanece ativo ou desativado |
Updated about 14 hours ago