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 na 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:
- Criar um novo endereço para uma conta
- Atualizar 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, sendo todos os campos obrigatórios:
cURL da chamada
curl --request POST \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/297/address \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.0.0' \
--cookie laravel_session=x56B3CKvG2pQZrXOEvRTCybJDu83u7oACbu56Zbj \
--data '{
"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
"number": "128",
"country": "BRA",
"complementaryAddress": "Suite C",
"neighborhood": "Mangabeira",
"city": "João Pessoa",
"state": "PB",
"zipCode": "58057325",
"mailingAddress": false,
"type": "RESIDENTIAL"
}'
Sucesso 201
Atenção!
Os caracteres especiais e acentuações dos dados preenchidos em todos os campos relacionados ao endereço, quando este for indicado como mailingAddress, serão ajustados para evitar erros no processo de embossing do cartão físico.
Significado dos Campos
| Campos (obrigatórios) | Tipo | Descrição |
|---|---|---|
| type | char | RESIDENTIAL para residencial, COMMERCIAL para comercial ou OTHER |
| address | string (50) | Endereço |
| 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 |
| zipCode | string (10) | Código de Endereçamento Postal (CEP) |
| maillingAdress | 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. |
| complementaryAddress | string (30) | Complemento do endereço |
Atenção!
O campo number é obrigatório. Caso o endereço não tenha número, informar o número "0" na requisição.
{
"version": false,
"status": 201,
"body": {
"id": 287,
"addressType": "RESIDENTIAL",
"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
"number": "128",
"complement": "Suite C",
"neighborhood": "Mangabeira",
"city": "João Pessoa",
"state": "PB",
"country": "BRA",
"zipAddress": "58057325",
"active": true,
"mailingAddress": false,
"createdAt": "2024-09-26 11:35:29"
}
}
Significado dos Campos
| Campo | Tipo | Descrição |
|---|---|---|
| id | int | Id do endereço gerado na criação da conta ou criação do endereço |
| addressType | char | RESIDENTIAL para residencial, COMMERCIAL para comercial ou OTHER |
| address | string (50) | Endereço |
| number | string (10) | Numero do endereço |
| neighborhood | string (20) | Bairro em que se encontra o endereço |
| city | string (20) | Cidade em que se encontra o endereço |
| state | string (2) | Estado em que se encontra o endereço |
| country | string (3) | Pais em que se encontra o endereço |
| zipCode | string (10) | Código de Endereçamento Postal |
| mailingAddress | 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 |
| complement | string (30) | Complemento do endereço |
| createdAt | string (50) | Data em que foi cadastrado este endereço |
| updatedAt | string (50) | Data da ultima atualização do endereço |
| active | boolean | Se este endereço permanece ativo ou ou não |
Atualizar os dados de um endereço
No processo de atualização de endereço é possível atualizar somente os que possuem a flag maillingAdress como false, caso o contrário será retornado statusCode 400 no endpoint.
Para atualizar um endereço envie a seguinte requisição, com os campos a serem atualizados:
cURL da chamada
curl --request PATCH \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}/address/{addressId} \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/10.0.0' \
--data '{
"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
"number": "128",
"country": "BRA",
"complementaryAddress": "Suite C",
"neighborhood": "Mangabeira",
"city": "João Pessoa",
"state": "PB",
"active": true,
"zipCode": "58057325",
"mailingAddress": false,
"type": "RESIDENTIAL"
}'
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": {
"id": 288,
"addressType": "RESIDENTIAL",
"address": "Rua Ex-Combatente Josué Ismael de Oliveira",
"number": "128",
"complement": "Suite C",
"neighborhood": "Mangabeira",
"city": "João Pessoa",
"state": "PB",
"country": "BRA",
"zipAddress": "58057325",
"active": true,
"mailingAddress": false,
"createdAt": "2024-09-26 11:41:18"
}
}
Atenção!
O campo number é obrigatório. Caso o endereço não tenha número, informar o número "0" na requisição.
Significado dos Campos
| Campo | Tipo | Descrição |
|---|---|---|
| id | int | Id do endereço gerado na criação da conta ou criação do endereço |
| addressType | Enum | RESIDENTIAL para residencial, COMMERCIAL para comercial ou OTHER |
| address | string (50) | Endereço |
| number | string (10) | Numero do endereço |
| neighborhood | string (20) | Bairro em que se encontra o endereço |
| city | string (20) | Cidade em que se encontra o endereço |
| state | string (2) | Estado em que se encontra o endereço |
| country | string (3) | Pais em que se encontra o endereço |
| zipCode | string (10) | Código de Endereçamento Postal - CEP |
| mailingAddress | 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 |
| complement | string (30) | Complemento do endereço |
| createdAt | string (50) | Data em que foi cadastrado este endereço |
| updatedAt | string (50) | Data da ultima atualização do endereço |
| active | boolean | Se este endereço permanece ativo ou desativado |
Updated 3 days ago