Consultar Boletos por Período (BETA)
Essa funcionalidade permite que os clientes da Celcoin consigam consultar mais de uma cobrança realizada para seus clientes utilizando filtros, como um intervalo de data e hora.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Consultar Cobrança por Período - [API Reference]
Você pode realizar a busca de cobrança pelos seguintes dados:
- Start
- End
- Status
- ReceiverDocument
- ReceiverAccount
- DebtorDocument
- DateType
- Sort
- Page
- Limit
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Start | Data Inicial da consulta de boletos | date-time | Sim |
| End | Data Final da consulta de boletos | date-time | Sim |
| Status | Status das cobrança. Valores Possíveis: CONFIRMED, PROCESSING, PENDING, ERROR e CANCELED | string | Não |
| ReceiverDocument | CNPJ ou CPF do beneficiário. | string | Não |
| ReceiverAccount | Número da conta BaaS do beneficiário. | string | Não |
| DebtorDocument | CNPJ ou CPF do pagador. | string | Não |
| DateType | Tipo de data utilizada como filtro. Valores possíveis: DUEDATE, CREATED e LIQUIDATION | string | Não |
| Sort | Tipo de ordenação. Valores possíveis: ASC e DESC | string | Não |
| Page | Página atual. | int | Não |
| Limit | Limite de consulta de dados. Máximo 500. | int | Não |
Só é possível trazer cobranças com prazo máximo 7 dias ao utilizar os filtros.
cURL da chamada
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/charge/search?Sort=asc&Page=1&Limit=500&Start=2025-09-24T18:03:34.502&End=2025-10-01T09:52:34.502&DateType=created&Status=confirmed' \
--header ''accept: application/json''
Sucesso 200
{
"version": "1.0.0",
"status": "SUCCESS",
"body": {
"data": [
{
"transactionId": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf",
"externalId": "externalId1",
"amount": 12.5,
"amountConfirmed": 13,
"duedate": "2023-12-30",
"status": "CONFIRMED",
"debtor": {
"name": "Marcos Samuel Duarte",
"document": "49188474801",
"postalCode": "06463035",
"publicArea": "Rua Mãe D'Água",
"number": "1004",
"complement": "Apto 123",
"neighborhood": "Jardim Mutinga",
"city": "Barueri",
"state": "SP"
},
"receiver": {
"name": "Emilly Malu Tereza Sales",
"document": "23234457824",
"postalCode": "06474070",
"publicArea": "Alameda França",
"city": "Barueri",
"state": "SP",
"account": "30023646056263"
},
"instructions": {
"fine": 10,
"interest": 5,
"discount": {
"amount": 1,
"modality": "fixed",
"limitDate": "2023-12-20"
}
},
"boleto": {
"transactionId": "32290",
"status": "Pago",
"bankEmissor": "santander",
"bankNumber": "4000178961",
"bankAgency": "1004",
"bankAccount": "0220060",
"barCode": "03392942700000009009022006000040001789610101",
"bankLine": "03399022070600004000317896101015294270000000900",
"bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA",
"invoiceNumber": "16124"
},
"pix": {
"transactionId": "817885753",
"transactionIdentification": "817885753",
"status": "Cancelado",
"key": "[email protected]",
"emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/cobv/303928a7b4034de09fddec6d1258c15d5204000053039865802BR5910Merle Yost6008Orinside61080863968162070503***6304D7D3"
},
"split": [
{
"account": "string",
"document": "string",
"percent": 0,
"amount": 0,
"aggregatePayment": true
}
],
"informations": [
"string"
]
}
],
"pagination": {
"page": 1,
"limit": 1,
"totalPages": 1,
"total": 1
}
}
}
Status da Cobrança
| Status | Descrição |
|---|---|
| ERROR | Indica que ocorreu um erro durante a geração da cobrança. |
| PENDING | A cobrança foi gerada com sucesso e está aguardando o pagamento. |
| PROCESSING | A cobrança está em fase de processamento, ou seja, está sendo gerada. |
| CONFIRMED | Indica que a cobrança foi paga com sucesso. Esse status é atualizado quando o crédito na conta foi realizado |
| CANCELED | Indica que a cobrança foi cancelada |
Error 400, 401, 403 e 500
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"body": {
"errorCode": "XXX001",
"message": "Ocorreu um erro interno durante a chamada da api."
}
}
}
Updated 23 days ago