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:

CampoDescriçãoTipoObrigatório
invoiceIdId da faturainteger✅ Sim
customerIdId do customerinteger (query)⚠️ Opcional
pageSizeTamanho de páginainteger (query)⚠️ Opcional
pageOffsetDeslocamento de página (inicia em 0)integer (query)⚠️ Opcional
orderOrdenação, ex.: ascstring (query)⚠️ Opcional
eventDateStartInício do período (ex.: 2025-01-01)string (query)⚠️ Opcional
eventDateEndFim do período (ex.: 2025-01-31)string (query)⚠️ Opcional
customerIdId do customerinteger (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

👍

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" }

Campos do response:

CampoDescriçãoTipo
hasNextIndica se há mais páginas de transaçõesboolean
transactions[].transactionIdId da transaçãointeger
transactions[].programIdId do programainteger
transactions[].accountIdId da containteger
transactions[].invoiceIdId da fatura em que a transação foi lançadainteger
transactions[].installment / numberOfInstallmentsNúmero da parcela atual / total de parcelasinteger
transactions[].softDescriptorDescrição exibida ao portador na faturastring
transactions[].processingCode / processingDescriptionCódigo e descrição do processamento da transaçãostring
transactions[].customerIdId do cliente/portadorstring
transactions[].userCategory / transactionGroup / entryModeClassificações da transação — A CONFIRMAR valores possíveisstring
transactions[].amount[].type / currency / valueComponentes do valor da transação (ex.: PRINCIPAL) e seu valorstring / string / decimal
transactions[].tax[].type / valueTributo aplicado (ex.: IOF) e seu valorstring / decimal
transactions[].eventDate(time) / paymentDate(time) / createdAtDatas do evento, do pagamento e de criação do registrostring (datetime)
transactions[].transactionType.description / credit / postedTransaction / categoryTipo da transação, se é crédito (true) ou débito (false), se já foi lançada (A CONFIRMAR) e sua categoriastring / boolean / boolean / string
transactions[].card.id / nameIdentificação do cartão utilizado na transaçãointeger / string
transactions[].authorization.type / network / trackingIdDados da autorização, incluindo bandeira (ex.: VISA)string
transactions[].merchant.name / city / state / category.descriptionDados do estabelecimento (nome, localização, categoria/MCC)string

Did this page help you?