Busca de transações de uma fatura
Esse endpoint retorna as transações (compras, pagamentos, encargos) lançadas em uma fatura específica, com suporte a paginação e filtro por período.
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.
Buscar as transações de uma fatura
GET /statements/transactions/{invoiceId}
Parâmetros:
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| invoiceId | Id da fatura | integer | ✅ Sim |
| customerId | Id do customer | integer (query) | ⚠️ Opcional |
| pageSize | Tamanho de página | integer (query) | ⚠️ Opcional |
| pageOffset | Deslocamento de página (inicia em 0) | integer (query) | ⚠️ Opcional |
| order | Ordenação, ex.: asc | string (query) | ⚠️ Opcional |
| eventDateStart | Início do período (ex.: 2025-01-01) | string (query) | ⚠️ Opcional |
| eventDateEnd | Fim do período (ex.: 2025-01-31) | string (query) | ⚠️ Opcional |
| customerId | Id do customer | integer (query) | ⚠️ Opcional |
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
{
"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
{ "version": 1, "status": 404, "error": "CRD999" }Campos do response:
| Campo | Descrição | Tipo |
|---|---|---|
| hasNext | Indica se há mais páginas de transações | boolean |
| transactions[].transactionId | Id da transação | integer |
| transactions[].programId | Id do programa | integer |
| transactions[].accountId | Id da conta | integer |
| transactions[].invoiceId | Id da fatura em que a transação foi lançada | integer |
| transactions[].installment / numberOfInstallments | Número da parcela atual / total de parcelas | integer |
| transactions[].softDescriptor | Descrição exibida ao portador na fatura | string |
| transactions[].processingCode / processingDescription | Código e descrição do processamento da transação | string |
| transactions[].customerId | Id do cliente/portador | string |
| transactions[].userCategory / transactionGroup / entryMode | Classificações da transação — A CONFIRMAR valores possíveis | string |
| transactions[].amount[].type / currency / value | Componentes do valor da transação (ex.: PRINCIPAL) e seu valor | string / string / decimal |
| transactions[].tax[].type / value | Tributo aplicado (ex.: IOF) e seu valor | string / decimal |
| transactions[].eventDate(time) / paymentDate(time) / createdAt | Datas do evento, do pagamento e de criação do registro | string (datetime) |
| transactions[].transactionType.description / credit / postedTransaction / category | Tipo da transação, se é crédito (true) ou débito (false), se já foi lançada (A CONFIRMAR) e sua categoria | string / boolean / boolean / string |
| transactions[].card.id / name | Identificação do cartão utilizado na transação | integer / string |
| transactions[].authorization.type / network / trackingId | Dados da autorização, incluindo bandeira (ex.: VISA) | string |
| transactions[].merchant.name / city / state / category.description | Dados do estabelecimento (nome, localização, categoria/MCC) | string |
Updated about 5 hours ago
Did this page help you?