Get transactions

You can use this endpoint to search for transactions based on various criteria. You can search for transactions by:

Customer
Whether it’s a debit or credit transaction
Its authorization event
Their ISO code
Their ID type
A specific statement

This endpoint is useful for:

Knowing about a product's performance
Calculating financial revenues
Informing customers about their statements

Transactions list

To retrieve a list of these transactions, use:

GET <URL>/transactions-core/v2/transactions

Transactions filters

Both network purchases and digital wallet transfers generate transactions associated with related accounts. Since an account might have several transactions, you can use these query parameters provided for this endpoint as filters.

Parameter	Description
`authorizationId`	Filters transactions by its authorization identification (ID).
`authorizationType`	Filters transactions by the authorization type. This can be `NETWORK` or `PLATFORM`.
`authorizationTrackingId`	Filters transactions by their authorization tracking IDs.
`credit`	Filters transactions by debits or credits. If set to `true`, it returns only credit transactions. If set to `false`, it returns only debit transactions. If omitted, it returns both.
`customerId`	Filters all transactions associated by a specific customer.
`eventDateEnd`	Filters transactions by the end of an event date.
`eventDateStart`	Filters transactions by the start of an event date.
`ids`	Filters transactions by their IDs.
`order`	Sorts the order of transactions shown. If set to `asc`, it returns the transactions by ascending order. If set to `dsc`, it returns the transactions by descending order.
`pageOffset`	Specifies the page number to begin transaction results.
`pageSize`	Sets the maximum amount of transactions per page.
`processingCode`	Filters transactions by the ISO processing code.
`statementId`	Filters transactions belonging to a specific statement.
`statementPost`	Shows whether a transaction was posted to a statement. If set to `true`, it shows the transaction in the statement.
`transactionTypeId`	Filters transactions by their type identifier.

Sample response

Here's an example of a filtered list of transactions.

{
   "id":39134019,
   "program_id":001,
   "account_id":01234567,
   "statement_id":1234,
   "installment":1,
   "number_of_Installments":1,
   "soft_descriptor":"purchase in installments in Brazil",
   "processing_code":"003100",
   "customer_id":23911414,
   "user_category":"SERVICES",
   "transaction_group":"EXPENSES",
   "amount":[
      {
         "type":"PRINCIPAL",
         "currency":"BRL",
         "value":3.44
      },
      {
         "type":"LOCAL",
         "currency":"BRL",
         "value":10
      },
      {
         "type":"SETTLEMENT",
         "currency":"USD",
         "value":10
      }
   ],
   "tax":null,
   "event_date":"2022-04-05T20:17:00Z",
   "created_at":"2022-04-05T17:17:03Z",
   "transaction_type":{
      "id":404,
      "description":"International IOF",
      "credit":false,
      "posted_transaction":true
   },
   "card":{
      "id":4926027,
      "name":"Teste Name"
   },
   "authorization":{
      "id":3702213,
      "type":"NETWORK",
      "code":"OEKIJD",
      "payment_method_id":"MASTERCARD",
      "tracking_id":"ef03879d-fe58-4583-8535-4901a52cd306"
   },
   "merchant":{
      "type":"NETWORK",
      "name":"purchase installments",
      "city":"SAO PAULO",
      "state":"Brazil",
      "category":{
         "code":"780",
         "description":"Category description Services LTDA",
         "group_name":"SERVICES",
         "network_group":"SERVICES"
      }
   }
}

For more information, go to Search for transactions with filters.

Transaction count associated by filter

To retrieve the total number of transactions associated with a filter, use:

GET <URL>/transactions-core/v2/transactions/total-items

For more information, go to Transaction count by given filter.

Get metadata about a specific transaction

To retrieve a specific transaction and its metadata, use:

GET <URL>/transactions-core/v2/transactions/transactionId

Then, set the includeMetadata query parameter to true.

For more information, go to Transactions by id.