Consultando dados de fatura

Contas/cartões do tipo pós-paga e multiapp utilizam a função crédito, em que o banco realiza o pagamento para os estabelecimentos. Por isso existe uma fatura mensal, que reúne todos os gastos daquele período, mostra o total devido, o limite utilizado e o valor e data de pagamento, permitindo ao cliente organizar o orçamento e escolher como quitar (à vista, parcelado, etc.).

Pré-requisitos para implementação

Possuir uma chave API da Celcoin. Essa chave é enviada após a contratação do serviço
.Ter familiaridade com APIs REST usando o protocolo OAuth 2.0.
Ter o produto Bin Sponsor — Cartões (Pós-pago) contratado.
Para uso em ambiente produtivo, contate a equipe comercial pelo e-mail [email protected].
Para dúvidas técnicas, utilize o suporte.
Após finalizar a integração, realizar a homologação do produto.

Para que o portador possa visualizar em seu aplicativo os dados da fatura, é possível utilizar das seguintes apis:

Listas todas as faturas de uma conta cartão. para que o portador possa visualizar a situação da fatura (ABERTA ou FECHADA) e também seu respectivo valor e vencimento.
Obter dados de uma fatura específica
Obter transações de uma fatura para que o portador possa visualizar todas as transações que compõem o valor da fatura que está sendo apresentada.

Listar faturas de uma conta

GET /statements/accounts/{accountId}/statements

Esse endpoint retorna a lista paginada de faturas (abertas, fechadas ou futuras) de uma conta de cartão.

Parâmetros:

Nome	Tipo	Local	Descrição
accountId *	integer	path	Id da conta
invoiceExternalId	integer	query	Id externo da fatura
perPage	integer	query	Itens por página (mín: 1, máx: 24)
status	string	query	FECHADA, ABERTA ou FUTURA
date	string ($date)	query	Data da fatura, formato Y-m-d
direction	string	query	Direção de ordenação: asc ou desc
orderBy	string	query	Campo de ordenação: status ou date
Program-Id	integer	header	Programa Id Externo

Exemplo de request:

GET /statements/accounts/116/statements?status=ABERTA&perPage=10&direction=desc&orderBy=date
Program-Id: 7
Authorization: Bearer <TOKEN>

cURL da chamada

curl --location '[https://sandbox-apicorp.celcoin.com.br/cards/v1/statements/accounts/116/statements?status=ABERTA\&perPage=10\&direction=desc\&orderBy=date](https://sandbox-apicorp.celcoin.com.br/cards/v1/statements/accounts/116/statements?status=ABERTA\&perPage=10\&direction=desc\&orderBy=date)' <br />--header 'Program-Id: 7' <br />--header 'Authorization: Bearer <TOKEN>'

Exemplo de response

👍
Sucesso 200

{
  "version": "1.0.0",
  "status": 200,
  "body": {
    "data": [
      {
        "invoiceId": 255,
        "accountId": 116,
        "programId": 7,
        "cycle": 2,
        "invoiceCycle": 2,
        "cycleStartDate": "2025-03-22",
        "cycleClosingDate": "2025-04-21",
        "dueDate": "2025-05-11",
        "dueDateBusinessDay": "2025-05-12",
        "totalCreditAmount": "0.00",
        "totalDebitAmount": "0.00",
        "balanceAmount": 696.55,
        "minimumPaymentAmount": "0.00",
        "invoiceExternalId": 2490388734,
        "invoiceStatus": "ABERTA",
        "createdAt": "2025-04-11 21:35:09",
        "updatedAt": "2025-01-01 00:00:00"
      }
    ],
    "currentPage": 1,
    "totalPages": 2,
    "itemsPerPage": 6,
    "nextPageUrl": null,
    "previousPageUrl": null
  }
}

Erros

❗
Error (404 / 500)

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

Campos do response:

Campo	Tipo	Descrição
version	string	Versão da API
status	integer	Código de status HTTP
invoiceId	integer	Id interno da fatura
accountId	integer	Id da conta
programId	integer	Id do programa
cycle	integer	Ciclo da fatura na conta
invoiceCycle	integer	Ciclo sequencial da fatura — A CONFIRMAR diferença exata em relação a cycle
cycleStartDate	string (date)	Data de início do ciclo
dueDate	string (date)	Data de fechamento do ciclo
dueDateBusinessDay	string (date)	Data de vencimento original
totalCreditAmount	string (date)	Vencimento ajustado para o próximo dia útil
totalDebitAmount	decimal (string)	Total de créditos lançados na fatura
balanceAmount	decimal (string)	Total de débitos lançados na fatura
minimumPaymentAmount	decimal	Saldo total da fatura
invoiceExternalId	decimal (string)	Valor mínimo de pagamento
invoiceStatus	integer	Id externo da fatura
createdAt	string	Status da fatura (ABERTA/FECHADA/FUTURA)
updatedAt	string (datetime)	Data/hora de criação do registro
Page	string (datetime)	Data/hora da última atualização
totalPages	integer	Página atual
itemsPerPage	integer	Total de páginas
PageUrl	integer	Itens por página
PageUrl	string ou null	URL da próxima página, ou null
	string ou null	URL da página anterior, ou null

Obter os dados de uma fatura específica

GET /statements

Retorna os dados de uma única fatura, buscando por invoiceId (interno Celcoin) ou por invoiceExternalId (identificador que o cliente pode ter associado externamente).

Exemplo de request:

GET /statements?invoiceId=255
Authorization: Bearer <TOKEN>

Ou, buscando pelo id externo:

GET /statements?invoiceExternalId=2490388734
Authorization: Bearer <TOKEN>

cURL da chamada

curl --location 'https://sandbox-apicorp.celcoin.com.br/cards/v1/statements?invoiceId=255' \
  --header 'Authorization: Bearer <TOKEN>'

Exemplo de response

👍
Sucesso 200

{
  "version": "1.0.0",
  "status": 0,
  "body": {
    "invoiceId": 0,
    "accountId": 0,
    "programId": 0,
    "cycle": 0,
    "invoiceCycle": 0,
    "cycleStartDate": "2024-05-31",
    "cycleClosingDate": "2024-05-31",
    "dueDate": "2024-06-10",
    "dueDateBusinessDay": "2024-06-10",
    "totalCreditAmount": "0.00",
    "totalDebitAmount": "0.00",
    "balanceAmount": "0.00",
    "minimumPaymentAmount": "0.00",
    "invoiceExternalId": 0,
    "invoiceStatus": "ABERTA",
    "createdAt": "2024-05-31 00:28:54",
    "updatedAt": "2024-05-31 00:29:52"
  }
}

Erros

❗
Error (404 / 500)

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

Buscar as transações de uma fatura

GET /statements/transactions/{invoiceId}

Exemplo de request:

GET /statements/transactions/255?pageSize=10&pageOffset=0&order=asc&eventDateStart=2025-01-01&eventDateEnd=2025-01-31
Authorization: Bearer <TOKEN>

cURL da chamada

curl --location 'https://sandbox-apicorp.celcoin.com.br/cards/v1/statements/transactions/255?pageSize=10&pageOffset=0&order=asc&eventDateStart=2025-01-01&eventDateEnd=2025-01-31' \
  --header 'Authorization: Bearer <TOKEN>'

Exemplo de response

👍
Sucesso 200

{
  "hasNext": true,
  "transactions": [
    {
      "transactionId": 0,
      "programId": 0,
      "accountId": 0,
      "invoiceId": 0,
      "installment": 0,
      "numberOfInstallments": 0,
      "softDescriptor": "string",
      "processingCode": "00",
      "processingDescription": "Purchase",
      "customerId": "dfcfdde-64bd-4a17-bbdf-3be627b2ard7",
      "userCategory": "SERVICES",
      "transactionGroup": "EXPENSES",
      "entryMode": "POS",
      "amount": [
        { "type": "PRINCIPAL", "currency": "string", "value": 0 }
      ],
      "tax": [
        { "type": "IOF", "value": 0 }
      ],
      "eventDate": "2022-08-24T19:15:24.000Z",
      "eventDatetime": "2022-08-24T19:15:24.000Z",
      "paymentDate": "2022-08-24T20:13:24.000Z",
      "paymentDatetime": "2022-08-24T20:13:24.000Z",
      "createdAt": "2022-08-24T19:05:24.000Z",
      "transactionType": {
        "id": 0,
        "description": "Credit voucher",
        "credit": true,
        "postedTransaction": true,
        "balanceImpact_id": 0,
        "category": "PAYMENTS/CREDITS"
      },
  "card": { "id": 0, "name": "string" },
      "authorization": {
        "id": 0,
        "type": "PLATFORM",
        "code": "string",
        "paymentMethodId": "string",
        "network": "VISA",
        "trackingId": "string",
        "correlatedAuthorizationId": 0
      },
      "merchant": {
        "id": "string",
        "type": "string",
        "name": "string",
        "city": "string",
        "state": "string",
        "category": {
          "code": "string",
          "description": "string",
          "groupName": "string",
          "networkGroup": "string"
        }
      }
    }
  ]
}

Erros

❗
Error (404 / 500)

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

Listas todas as faturas de uma conta cartão. para que o portador possa visualizar a situação da fatura (ABERTA ou FECHADA) e também seu respectivo valor e vencimento.
Obter transações de uma fatura para que o portador possa visualizar todas as transações que compõem o valor da fatura que está sendo apresentada.

Updated 4 days ago

Did this page help you?