Listar Contas
Essa funcionalidade permite que os clientes da Celcoin consigam buscar contas dos BaaS, a busca pode ser feita individualmente ou por listagem de data;
Passos Buscar Contas Individuais
- Realizar autenticação na API - [API Reference]
- Buscar uma conta - [API Reference]
Buscar Contas Individuais
Você pode realizar a busca de contas pelos seguintes dados:
- documentNumber (CPF)
- account (Numero da conta do cliente)
cURL da chamada1
curl --request GET \
--url 'https://sandbox.openfinance.celcoin.dev/baas-accountmanager/v1/account/fetch?Account=123456' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"statusAccount": "ATIVO",
"documentNumber": "25400754015",
"phoneNumber": "+5512981175704",
"email": "[email protected]",
"motherName": "Nome Sobrenome",
"fullName": "Nome Sobrenome",
"socialName": "Nome",
"birthDate": "31-12-1984",
"address": {
"postalCode": "12211400",
"street": "Av Paulista",
"number": "313",
"addressComplement": "Em frente ao parque.",
"neighborhood": "Bairro",
"city": "São Paulo",
"state": "SP",
"longitude": "-46.6488",
"latitude": "-23.6288"
},
"isPoliticallyExposedPerson": false,
"account": {
"branch": "0001",
"account": "300539137798"
},
"createDate": "2022-10-28T13:50:55"
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE041",
"message": "Account possui tamanho maximo de 20 caracteres."
}
}
Tabela de errorCode
Code | Message |
---|---|
CBE073 | É necessário informar pelo menos um dos campos: account, ou documentNumber. |
CBE039 | Account invalido. |
CBE040 | DocumentNumber invalido. |
CBE041 | Account possui tamanho maximo de 20 caracteres. |
CBE042 | DocumentNumber possui tamanho maximo de 14 caracteres. |
Passos Buscar listagem de Contas
- Realizar autenticação na API - [API Reference]
- Buscar uma listagem de contas - [API Reference]
Buscar listagem de Contas
Regras para listar as contas
- O Intervalo maximo de busca por data é de 7 dias;
- Os parametros Limit e Page não são obrigatorios;
cURL da chamada
curl --request GET \
--url 'https://sandbox.openfinance.celcoin.dev/baas-accountmanager/v1/account/fetch-all?DateFrom=2022-07-21&DateTo=2022-07-28' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"totalItems": 3,
"currentPage": 1,
"totalPages": 1,
"dateFrom": "22/10/2022 00:00:00",
"dateTo": "28/10/2022 23:59:59",
"subAccounts": [
{
"statusAccount": "ATIVO",
"documentNumber": "25400754015",
"phoneNumber": "+5512981175704",
"email": "[email protected]",
"motherName": "Nome Sobrenome",
"fullName": "Nome Sobrenome",
"socialName": "Nome",
"birthDate": "31-12-1984",
"address": {
"postalCode": "06455030",
"street": "Rua das Andorinhas",
"number": "343",
"addressComplement": "proximo a lanchonete do zeca",
"neighborhood": "Rua das Maravilhas",
"city": "Sao Paulo",
"state": "SP",
"longitude": null,
"latitude": null
},
"isPoliticallyExposedPerson": false,
"createDate": "2022-10-25T20:33:34",
"closeDate": "2022-10-25T20:33:47",
"closeReason": "Motivo X"
},
{
"statusAccount": "ATIVO",
"documentNumber": "25400754015",
"phoneNumber": "+5512981175704",
"email": "[email protected]",
"motherName": "Nome Sobrenome",
"fullName": "Nome Sobrenome",
"socialName": "Nome",
"birthDate": "31-12-1984",
"address": {
"postalCode": "06455030",
"street": "Rua das Andorinhas",
"number": "343",
"addressComplement": "proximo a lanchonete do zeca",
"neighborhood": "Rua das Maravilhas",
"city": "Sao Paulo",
"state": "SP",
"longitude": null,
"latitude": null
},
"isPoliticallyExposedPerson": false,
"createDate": "2022-10-25T20:33:54",
"closeDate": "2022-10-25T20:34:06",
"closeReason": "Desejo encerrar a conta..."
}
]
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CIE999",
"message": "Ocorreu um erro interno durante a chamada da api.."
}
}
Tabela de errorCode
Code | Message |
---|---|
CBE066 | Limite sua busca entre 1 a 200. |
CBE067 | Página informada não contem contas. |
CBE068 | dateFrom não pode ser maior que dateTo. |
CBE076 | dateFrom e dateTo são obrigatórios para busca das contas. |
CBE079 | Consulta conta não permitida.Diferença entre dateFrom e dateTo não pode ultrapassar 7 dias. |
CBE039 | Account invalido. |
CBE040 | DocumentNumber invalido. |
CBE041 | Account possui tamanho maximo de 20 caracteres. |
CBE042 | DocumentNumber possui tamanho maximo de 14 caracteres. |
CBE080 | Page invalido. |
CBE088 | Limit invalido. |
Updated 11 months ago