Dados de Pagamento de Fatura

A API de Pagamento de Fatura retorna os instrumentos de pagamento disponíveis para a liquidação de uma fatura de cartão pós-pago: boleto bancário e/ou Pix Cobrança com Vencimento (Pix COBV).

Esta API é o ponto único para obter os dados necessários para exibir ao cliente final a cobrança da fatura — código de barras/linha digitável do boleto e/ou EMV/QR Code do Pix — sem a necessidade de gerar esses dados manualmente.

Passos para Integrar

  • Realizar autenticação na API via OAuth 2.0 (https://oauth.net/2/), utilizando a chave de API da Celcoin
  • ;Obter o invoiceId da fatura a ser paga, via Bin Sponsor - Fatura (Statements);
  • Consultar os instrumentos de pagamento (/statements/{invoiceId}/paymentDetail);
  • Exibir ao cliente final o boleto (código de barras/linha digitável) e/ou o Pix (QR Code) retornados, sem regenerar ou recalcular esses dados.

URL Base Sandbox: https://sandbox-apicorp.celcoin.com.br/cards/v1

Informações importantes:

  1. Regras gerais de pagamento:

  • O retorno pode conter um item de boleto (identificado pela presença de billId) e/ou um item de Pix Cobrança com Vencimento — COBV (identificado pela presença de pixId), dentro do array billing. Ambos irão ser gerados;
  • Utilize sempre os dados retornados pela própria API (código de barras/linha digitável, EMV/QR Code) — não gere esses dados manualmente, nem os armazene além do necessário;
  • paymentType: "PARCIAL" no boleto sugere que ele pode ser pago parcialmente.
  1. Dados sensíveis:

  • Os campos de beneficiary, beneficiaryFinal, payer (boleto) e debtor, receiver (Pix) contêm dados pessoais e bancários do titular/portador — tratar como informação sensível, seguindo as políticas de proteção de dados da Celcoin;
  • O EMV (emv) e a URL do QR Code (url) do Pix não devem ser expostos em logs, URLs de terceiros ou canais não seguros.
  1. Validade:

  • expirationAfterPayment no Pix COBV indica quantos dias a cobrança permanece válida/consultável após o pagamento.
  • A CONFIRMAR se, após o vencimento (dueDate) do boleto/Pix sem pagamento, este endpoint passa a retornar um novo instrumento (reemissão) ou o mesmo instrumento vencido.

Obter detalhes de pagamento da fatura:

GET /statements/{invoiceId}/paymentDetail

Retorna os dados dos instrumentos de pagamento disponíveis para liquidação da fatura — boleto e/ou Pix Cobrança com Vencimento (COBV).

Parâmetros:

CampoDescriçãoTipoObrigatório
invoiceIdId da faturainteger✅ Sim
Program-IdPrograma Id Externointeger (header)⚠️ Opcional

Exemplo de request:

GET /statements/255/paymentDetail
Program-Id: 1
Authorization: Bearer <TOKEN>

cURL da chamada

curl --location 'https://sandbox-apicorp.celcoin.com.br/cards/v1/statements/255/paymentDetail' \
  --header 'Program-Id: 1' \
  --header 'Authorization: Bearer <TOKEN>'

Exemplo de response

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "invoiceId": 1,
    "accountId": 1,
    "programId": 1,
    "cycle": 4,
    "invoiceCycle": 3,
    "cycleStartDate": "2025-04-26",
    "cycleClosingDate": "2025-05-26",
    "dueDate": "2025-06-10",
    "dueDateBusinessDay": "2025-06-10",
    "totalCreditAmount": "17.08",
    "totalDebitAmount": "23.52",
    "balanceAmount": "23.52",
    "minimumPaymentAmount": "0.00",
    "invoiceExternalId": 1408641988,
    "invoiceStatus": "FECHADA",
    "createdAt": "2025-07-31 19:42:58",
    "updatedAt": "2025-07-31 19:50:00",
    "billing": [
      {
        "billId": 89,
        "requestId": "025fe274-6764-454b-8f41-a3454e3fa7c0",
        "externalId": "688bc7455f74e8dcfc597779",
        "accountId": 236,
        "nominalValue": "23.52",
        "bankNumber": "3000000000155829",
        "billNumber": "3025073106194552343",
        "billReferenceNumber": "1753990984815000731",
        "barCode": "50992116900000023520000000003000000000166829",
        "digitableLine": "50990000010000300000700001828292215590000002352",
        "dueDate": "2025-08-10",
        "issueDate": "2025-07-31",
        "origin": "AUTOMATICO",
        "documentKind": "DUPLICATA_MERCANTIL",
        "paymentType": "PARCIAL",
        "status": "REGISTRADO",
        "beneficiary": { "documentType": "CNPJ", "document": "<CNPJ>", "name": "<NOME_CLIENTE>" },
        "beneficiaryFinal": { "documentType": "CNPJ", "document": "<CNPJ>", "name": "<NOME_CLIENTE>" },
        "payer": {
          "documentType": "CPF",
          "name": "<NOME_PORTADOR>",
          "document": "<CPF>",
          "address": "<ENDERECO>",
          "city": "<CIDADE>",
          "state": "<UF>",
          "zipCode": "<CEP>"
        }
      },
      {
        "pixId": 2,
        "requestId": "cc6c1e1e-fb50-44bb-b341-d3d292d8111f",
        "externalId": "<EXTERNAL_ID>",
        "accountId": 219,
        "nominalValue": "764.26",
        "url": "<PIX_QRCODE_URL>",
        "emv": "<PIX_EMV_PAYLOAD>",
        "type": "COBV",
        "dueDate": "2026-03-03",
        "issueDate": "2026-03-03",
        "origin": "AUTOMATICO",
        "status": "ACTIVE",
        "statusDescription": "Ativo, mas ainda não teve pagamento",
        "expirationAfterPayment": "5",
        "debtor": {
          "documentType": "CPF",
          "name": "<NOME_PAGADOR>",
          "email": "<EMAIL>",
          "document": "<CPF>",
          "address": "<ENDERECO>",
          "city": "<CIDADE>",
          "state": "<UF>",
          "zipCode": "<CEP>"
        },
        "receiver": {
          "documentType": "CNPJ",
          "name": "<NOME_CLIENTE>",
          "document": "<CNPJ>",
          "address": "<ENDERECO>",
          "city": "<CIDADE>",
          "state": "<UF>",
          "zipCode": "<CEP>"
        }
      }
    ]
  }
}

Erros

O swagger disponibiliza apenas um formato genérico de erro para este endpoint:

❗

Error (404 / 500)

{ "version": 1, "status": 404, "error": "CRD999" }

Campos do response:

CampoDescriçãoTipo
body.dueDate / dueDateBusinessDayVencimento original e ajustado para dia útilstring (date)
body.totalCreditAmount / totalDebitAmount / balanceAmountTotais de crédito, débito e saldo da faturadecimal (string)
body.minimumPaymentAmountValor mínimo de pagamento — ver Bin Sponsor - Crédito Rotativo (Cálculo do Valor Mínimo)decimal (string)
body.invoiceStatusStatus da faturastring
body.billing[].billIdPresente quando o item é um boleto — id do boletointeger
body.billing[].bankNumber / billNumber / barCode / digitableLineIdentificadores e código de barras/linha digitável do boletostring
body.billing[].dueDate / issueDateVencimento e emissão do boletostring (date)
body.billing[].paymentTypeTipo de pagamento aceito (ex.: PARCIAL)string
body.billing[].statusStatus do boleto (ex.: REGISTRADO)string
body.billing[].beneficiary / beneficiaryFinal / payerDados do beneficiário e do pagador do boleto (sensíveis)object
body.billing[].pixIdPresente quando o item é uma cobrança Pix COBV — id da cobrançainteger
body.billing[].url / emvQR Code (URL) e payload EMV do Pixstring
body.billing[].typeTipo de cobrança Pix (COBV)string
body.billing[].status / statusDescriptionStatus da cobrança Pix e sua descriçãostring
body.billing[].expirationAfterPaymentDias de validade da cobrança após o pagamentostring
body.billing[].debtor / receiverDados do pagador e do recebedor do Pix (sensíveis)object

Tabela de apoio:

ContextoStatusSignificado
BoletoREGISTRADOBoleto registrado no banco emissor, apto para pagamento.
Pix COBVACTIVECobrança Pix ativa e aguardando pagamento.



Did this page help you?