Listar Cobranças

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.

Modelo de request:

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/charges' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{acess_token}}' \
--header 'Content-Type: application/json' \

Modelo de retorno:

{
    "totalQtdFoundInPage": 1,
    "Charges": [
        {
            "galaxPayId": 1,
            "myId": "pay-67f59150ca9c40.45124410",
            "mainPaymentMethodId": "creditcard",
            "additionalInfo": "Lorem ipsum dolor sit amet.",
            "value": 12999,
            "status": "active",
          
            "Transactions": [
                {
                    "galaxPayId": 1,
                    "myId": "pay-67f591516ca7f5.60454399",
                    "value": 12999,
                    "payday": "2025-04-08",
                    "additionalInfo": "Lorem ipsum dolor sit amet.",
                    "installment": 3,
                    "statusDate": "2025-04-08 18:12:49",
                    "datetimeLastSentToOperator": "2025-04-08 18:12:49",
                    "status": "captured",
                    "fee": 300,
                    "statusDescription": "Capturada na Operadora",
                    "tid": "pay-67f5915203df50.88935858",
                    "authorizationCode": "pay-67f59152111723.68682304",
                    "reasonDenied": "Limite do cartão insuficiente.",
                    "AbecsReasonDenied": {
                        "code": "51",
                        "message": "Saldo/limite insuficiente"
                 
                    }
                }
            ],
            "Customer": {
                "galaxPayId": 1,
                "myId": "pay-67f59153638801.16393108",
                "name": "Lorem ipsum dolor sit amet.",
                "document": "31277264813",
                "emails": [
                    "[email protected]",
                    "[email protected]"
                ],
                "phones": [
                    3140201512,
                    31983890110
                ],
                "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"
                }
            },
            "PaymentMethodCreditCard": {
                "Card": {
                    "myId": "pay-67f591544da745.48884622",
                    "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": "cielo,bin"
                    },
                    "expiresAt": "2025-04"
                },
            
                "qtdInstallments": 12
            }
            
        }    
        
    ]
}

Tabela de Erros

Os principais erros de negócio mapeados nas APIs acima estão disponíveis nesse link

Homologação

As instruções para realizar a homologação deste produto estão centralizadas neste link