DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consultar uma Cobrança Avulsa

Suggest Edits

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

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Consultar Cobrança - [API Reference]

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

  • TransactionId
  • ExternalId

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/charge?TransactionId=string' \
--header 'Authorization: Bearer {{token}}'

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "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-20T00:00:00.0000000"
      }
    },
    "boleto": {
      "transactionId": "32290",
      "status": "Pago",
      "bankEmissor": "santander",
      "bankNumber": "4000178961",
      "bankAgency": "1004",
      "bankAccount": "0220060",
      "barCode": "03392942700000009009022006000040001789610101",
      "bankLine": "03399022070600004000317896101015294270000000900",
      "bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA"
    },
    "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": [
      {
        "amount": 5,
        "account": "40655847871"
      }
    ]
  }
}

Status da Cobrança

StatusDescrição
ERRORIndica que ocorreu um erro durante a geração da cobrança.
PENDINGA cobrança foi gerada com sucesso e está aguardando o pagamento.
PROCESSINGA cobrança está em fase de processamento, ou seja, está sendo gerada.
CONFIRMEDIndica que a cobrança foi paga com sucesso.

❗

Error 400

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

Updated 4 months ago