Listar Cobranças Avulsas
Para consultar uma empresa cadastrada é necessário realizar uma chamada na api Listar Cobranças utilizando o método GET, onde precisa passar os parâmetros da consulta.
| Parâmetro | Descrição | Obrigatório | Tipo |
|---|---|---|---|
| myIds | ids da cobrança avulsa no seu sistema. Separe cada id por vírgula. | NÃO | string |
| customerMyIds | Id do cliente no seu sistema. Separe cada id por vírgula. | NÃO | string |
| createdAtFrom | Data de criação inicial. Formato yyyy-MM-dd | NÃO | date |
| createdAtTo | Data de criação final. Formato yyyy-MM-dd | NÃO | date |
| createdOrUpdatedAtFrom | Data de criação/atualização inicial. Formato yyyy-MM-dd | NÃO | date |
| createdOrUpdatedAtTo | Data de criação/atualização final. Formato yyyy-MM-dd | NÃO | date |
| status | Status da cobrança avulsa. Separe cada valor por vírgula. Valores possíveis: active, canceled, closed, waitingPayment, inactive | NÃO | string |
| ExtraFields | Buscar por um ou mais campos adicionais. String que deverá ser montada da seguinte maneira: NOME_DA_TAG.valor que quero buscar,NOME_DA_TAG2.valor1111 | NÃO | array |
| startAt | Ponteiro inicial para trazer os registros | SIM | int |
| limit | Quantidade máxima de registros para trazer. | SIM | int |
| order | Ordenação do resultado. String que deverá ser montada da seguinte maneira: campoDaEntidade.tipoDeOrdemCaso queira passar mais de uma ordenação, separar por vírgula: campoDaEntidade.tipoDeOrdem, campoDaEntidade2.tipoDeOrdem Valores possíveis: createdAt.asc, createdAt.esc, updatedAt.asc, updatedAt.desc | NÃO | string |
Modelo de request:
curl --request GET \
--url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/charges?account={CONTA_BAAS}&myIds=1%2C2%2C3&galaxPayIds=4%2C5%2C6&customerMyIds=9%2C1%2C2&customerGalaxPayIds=2%2C3%2C5&createdAtFrom=2026-02-01&createdAtTo=2026-02-01&createdOrUpdatedAtFrom=2026-02-01&createdOrUpdatedAtTo=2026-02-01&status=active' \
--header 'accept: application/json' \
--header 'authorization: Bearer {TOKEN}'Modelo de retorno:
{
"totalQtdFoundInPage": 1,
"Charges": [
{
"galaxPayId": 1,
"myId": "pay-6942ccf6c0d7d0.43172109",
"planGalaxPayId": 1,
"planMyId": "pay-6942ccf6d4a342.20198048",
"Split": [
{
"galaxPayId": 335,
"companyGalaxPayId": 18818,
"billGalaxPayId": 9737,
"type": "fixed",
"paymentMethod": "creditcard",
"value": 100,
"groupGalaxPayId": 126
}
],
"paymentLink": "https://app.celcoin.com.br/link-payment",
"mainPaymentMethodId": "creditcard",
"additionalInfo": "Lorem ipsum dolor sit amet.",
"value": 12999,
"status": "active",
"payedOutsideGalaxPay": false,
"Transactions": [
{
"galaxPayId": 1,
"myId": "pay-6942ccf77a7388.12163279",
"value": 12999,
"payday": "2025-12-17",
"additionalInfo": "Lorem ipsum dolor sit amet.",
"installment": 3,
"statusDate": "2025-12-17 12:32:07",
"datetimeLastSentToOperator": "2025-12-17 12:32:07",
"status": "captured",
"fee": 300,
"statusDescription": "Capturada na Operadora",
"tid": "pay-6942ccf7da6206.65095432",
"authorizationCode": "pay-6942ccf7e3e480.23645494",
"reasonDenied": "Limite do cartão insuficiente.",
"Invoice": {
"description": "Lorem ipsum dolor sit amet.",
"number": "20200000123",
"status": "emmited",
"statusDescription": "Emitida com sucesso.",
"pdf": "https://app.celcoin.com.br/link-pdf",
"statusDate": "2025-12-17 12:32:08",
"xml": "https://app.celcoin.com.br/link-xml"
},
"ConciliationOccurrences": [
{
"type": "payment",
"liquidValue": 10000,
"depositDate": "2025-12-17",
"taxValue": 300,
"taxPercent": 300,
"bankName": "Banco Santander (Brasil) S.A.",
"bankNumber": 33,
"agency": "5412",
"account": "415789"
}
],
"AbecsReasonDenied": {
"code": "51",
"message": "Saldo/limite insuficiente"
},
"cardOperatorId": "rede",
"Boleto": {
"pdf": "https://app.celcoin.com.br/link-pdf",
"bankLine": "23312323232323232323232323232",
"bankNumber": 33,
"barCode": "322132323232323232323232",
"bankEmissor": "santander",
"bankAgency": "0001",
"bankAccount": "12345"
},
"Pix": {
"qrCode": "ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123ABC123",
"reference": "E2025121712320978B7E5DB0E21DAE9FF2962600AB47C2F",
"image": "https://app.celcoin.com.br/link-image-qrcode",
"page": "https://app.celcoin.com.br/link-page-qrcode",
"endToEndId": "E2025121712320978B7E5DB0E21DAE9FF2962600AB47C2F"
},
"Antifraud": {
"ip": "192.168.2.10",
"sessionId": "270e34e2365e2ca034c24f2907f24dd3",
"sent": true,
"approved": true
},
"CreditCard": {
"Card": {
"myId": "pay-6942ccf9617da6.45271108",
"galaxPayId": 1,
"number": "5451*********1515",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Brand": {
"id": "mastercard",
"name": "MasterCard",
"maxInstallment": 12,
"operatorIds": "pagseguro,cielo"
},
"expiresAt": "2025-12"
}
}
}
],
"Customer": {
"galaxPayId": 1,
"myId": "pay-6942ccf9cb9079.14101720",
"name": "Lorem ipsum dolor sit amet.",
"document": "17622017043",
"emails": [
"[email protected]",
"[email protected]"
],
"phones": [
3140201512,
31983890110
],
"invoiceHoldIss": false,
"municipalDocument": "121212121212-02",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Address": {
"zipCode": "30411330",
"street": "Rua platina",
"number": "1330",
"complement": "2º andar",
"neighborhood": "Prado",
"city": "Belo Horizonte",
"state": "MG"
},
"ExtraFields": [
{
"tagName": "CP_MATRICULA",
"tagValue": "A532620"
}
]
},
"PaymentMethodCreditCard": {
"cardOperatorId": "bin",
"Card": {
"myId": "pay-6942ccfaa86932.45203444",
"galaxPayId": 1,
"number": "5451*********1515",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Brand": {
"id": "mastercard",
"name": "MasterCard",
"maxInstallment": 12,
"operatorIds": "pagseguro,getnet"
},
"expiresAt": "2025-12"
},
"Link": {
"minInstallment": 4,
"maxInstallment": 12
},
"qtdInstallments": 12
},
"PaymentMethodBoleto": {
"fine": 100,
"interest": 200,
"instructions": "Lorem ipsum dolor sit amet.",
"deadlineDays": 1,
"Discount": {
"qtdDaysBeforePayDay": 1,
"type": "percent",
"value": 12999
}
},
"PaymentMethodPix": {
"fine": 100,
"interest": 200,
"instructions": "Lorem ipsum dolor sit amet.",
"Deadline": {
"type": "days",
"value": 60
},
"Discount": {
"qtdDaysBeforePayDay": 1,
"type": "percent",
"value": 1500
}
},
"InvoiceConfig": {
"description": "Lorem ipsum dolor sit amet.",
"smu": 123456,
"type": "onlyOne",
"createOn": "daysBeforePayDay"
},
"ExtraFields": [
{
"tagName": "CP_FILIAL",
"tagValue": "MG 01"
}
],
"Contract": {
"name": "Lorem ipsum dolor sit amet.",
"document": "15140968975",
"ip": "192.168.0.1",
"acceptedAt": "2025-12-17 12:32:12",
"pdf": "https://app.celcoin.com.br/link-download-pdf"
}
}
]
}