Listar endereços de uma conta
Para obter informações sobre endereços cadastrados, você pode:
- Listar endereços de uma conta
- Buscar um endereço especifico
Passos para Integrar
- Realizar autenticação na API.
- Realizar a consulta das informações.
Listar endereços de uma conta
Para obter informações sobre os diversos endereços vinculados a uma conta, envie uma requisição com o ID da conta para o endpoint correspondente.
curl --request GET \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}/address \
--header 'Authorization: Bearer TOKEN' \
--header 'User-Agent: insomnia/10.0.0' \
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": [
{
"id": 283,
"addressType": "RESIDENTIAL",
"address": "Nowhere St.",
"number": "68989",
"complement": "Suite C",
"neighborhood": "Faraway Creek 2",
"city": "Smallville",
"state": "KS",
"country": "USA",
"zipAddress": "012365",
"active": true,
"mailingAddress": false,
"createdAt": "2024-09-25 00:00:00"
},
{
"id": 284,
"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-25 12:31:38"
},
{
"id": 285,
"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": true,
"createdAt": "2024-09-25 12:32:24"
},
{
"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"
},
{
"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"
}
]
}
| Campo | Tipo | Descrição |
|---|---|---|
| id | int | Id do endereço gerado na criação da conta ou criação do endereço |
| addressType | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| address | string (50) | Nome da rua ou avenida |
| 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 |
| active | boolean | Se este endereço permanece ativo ou ou não |
Buscar um endereço em específico
Para obter informações de um endereço específico, envie uma requisição com o ID do endereço para o endpoint correspondente.
curl --request GET \
--url https://sandbox-apicorp.celcoin.com.br/cards/v1/accounts/{accountId}/address/{addressId} \
--header 'Authorization: Bearer {TOKEN}' \
--header 'User-Agent: insomnia/10.0.0' \
Sucesso 200
{
"version": "1.0.0",
"status": 200,
"body": {
"id": 283,
"addressType": "RESIDENTIAL",
"address": "Nowhere St.",
"number": "68989",
"complement": "Suite C",
"neighborhood": "Faraway Creek 2",
"city": "Smallville",
"state": "KS",
"country": "USA",
"zipAddress": "012365",
"active": true,
"mailingAddress": false,
"createdAt": "2024-09-25 00:00:00"
}
}
| Campo | Tipo | Descrição |
|---|---|---|
| id | int | Id do endereço gerado na criação da conta ou criação do endereço |
| addressType | char | Indica o Logradouro do endereço, R - Rua, A - Avenida |
| address | string (50) | Nome da rua ou avenida |
| number | string (10) | Numero do local |
| neighborhood | string (20) | Bairro em que se encontra o endereç |
| 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 que o cliente deve receber os cartões |
| complement | string (30) | Complemento da localização |
| createdAt | string (50) | Data em que foi cadastrado este endereço |
| active | boolean | Se este endereço permanece ativo ou desativado |
Updated 2 months ago