Consultar Boleto Emitido

Essa funcionalidade permite que os clientes da Celcoin consigam consultar cobranças realizadas para seus clientes.

Você pode realizar a busca de cobrança pelos seguintes dados:

boletoId

cURL da chamada

curl -X GET https://api.onnixpay.com/sdk/boleto/{{boletoId}} \
    -H "X-API-Key: ox_your_key" \

Sucesso 200

{
    "success": true,
    "data": {
        "transactionId": "b4f888c9-74c3-4b0b-a12d-2b0262c60124",
        "clientCode": "e2a774dd-10c0-4dfa-9b3b-3d23e1ea627d",
        "amount": 10,
        "amountConfirmed": null,
        "duedate": "2025-11-15T00:00:00.000Z",
        "status": "REGISTERED",
        "debtor": {
            "name": "Priscila Isabelly Martins",
            "document": "76410645589",
            "postalCode": "57442970",
            "publicArea": "Praça da Indepêndencia 153",
            "number": 885,
            "complement": null,
            "neighborhood": "Centro",
            "city": "São Paulo",
            "state": "SP"
        },
        "receiver": {
            "name": "54.776.657 PEDRO HENRIQUE CHUEIRI",
            "document": "54776657000174",
            "account": "434758314"
        },
        "instructions": [],
        "boleto": {
            "transactionId": "69189c7f2c7a6ff999fdd029",
            "status": "REGISTERED",
            "bankEmissor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA",
            "bankNumber": "4270960",
            "bankAgency": "0001",
            "bankAccount": "434758314",
            "barCode": "50998126600000010000000000000000000004270960",
            "bankLine": "50990000010000000000000042709600812660000001000",
            "bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA"
        },
        "pix": {
            "transactionId": "2827820059",
            "transactionIdentification": "00020101021226960014br.gov.bcb.pix2574qrcode.pix.celcoin.com.br/pixqrcode/v2/cobv/18fb74ee9765ed519732110e26c66b5204000053039865802BR592354776657 PEDRO HENRIQUE6009Sao Paulo62070503***6304B67F",
            "status": "PENDING",
            "key": "dc27461a-de75-45b3-bceb-b4278e25fee4",
            "emv": "00020101021226960014br.gov.bcb.pix2574qrcode.pix.celcoin.com.br/pixqrcode/v2/cobv/18fb74ee9765ed519732110e26c66b5204000053039865802BR592354776657 PEDRO HENRIQUE6009Sao Paulo62070503***6304B67F"
        }
    },
    "timestamp": "2025-11-17T17:11:05.082Z"
}

Status da Cobrança

Status	Descrição
ERROR	Indica que ocorreu um erro durante a geração da cobrança.
REGISTERED	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.
CANCELED	Indica que a cobrança foi cancelada

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "OBE001",
    "message": "Ocorreu um erro interno durante a chamada da api."
  }
}