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:
- 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.
- Os campos de
beneficiary,beneficiaryFinal,payer(boleto) edebtor,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.
expirationAfterPaymentno 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:
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| invoiceId | Id da fatura | integer | ✅ Sim |
| Program-Id | Programa Id Externo | integer (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
{
"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:
{ "version": 1, "status": 404, "error": "CRD999" }Campos do response:
| Campo | Descrição | Tipo |
|---|---|---|
| body.dueDate / dueDateBusinessDay | Vencimento original e ajustado para dia útil | string (date) |
| body.totalCreditAmount / totalDebitAmount / balanceAmount | Totais de crédito, débito e saldo da fatura | decimal (string) |
| body.minimumPaymentAmount | Valor mínimo de pagamento — ver Bin Sponsor - Crédito Rotativo (Cálculo do Valor Mínimo) | decimal (string) |
| body.invoiceStatus | Status da fatura | string |
| body.billing[].billId | Presente quando o item é um boleto — id do boleto | integer |
| body.billing[].bankNumber / billNumber / barCode / digitableLine | Identificadores e código de barras/linha digitável do boleto | string |
| body.billing[].dueDate / issueDate | Vencimento e emissão do boleto | string (date) |
| body.billing[].paymentType | Tipo de pagamento aceito (ex.: PARCIAL) | string |
| body.billing[].status | Status do boleto (ex.: REGISTRADO) | string |
| body.billing[].beneficiary / beneficiaryFinal / payer | Dados do beneficiário e do pagador do boleto (sensíveis) | object |
| body.billing[].pixId | Presente quando o item é uma cobrança Pix COBV — id da cobrança | integer |
| body.billing[].url / emv | QR Code (URL) e payload EMV do Pix | string |
| body.billing[].type | Tipo de cobrança Pix (COBV) | string |
| body.billing[].status / statusDescription | Status da cobrança Pix e sua descrição | string |
| body.billing[].expirationAfterPayment | Dias de validade da cobrança após o pagamento | string |
| body.billing[].debtor / receiver | Dados do pagador e do recebedor do Pix (sensíveis) | object |
Tabela de apoio:
| Contexto | Status | Significado |
|---|---|---|
| Boleto | REGISTRADO | Boleto registrado no banco emissor, apto para pagamento. |
| Pix COBV | ACTIVE | Cobrança Pix ativa e aguardando pagamento. |
Updated about 5 hours ago