Get Transactions

The Transaction Requests endpoint allows retrieving transaction data. This endpoint is particularly useful when you need to validate the status of one or more transactions or locate a specific one. Its usage is straightforward, as it does not require a Request Body. There are two main use cases:

• To retrieve a single transaction using transactionId.
• To retrieve multiple transactions using transactionOrderId and date filters.
• To retrieve transactions from a specified or multiple accounts

Let’s explore these functionalities in more detail:

1. Get a Single Transaction using transactionId

This operation aims to fetch details about a specific transaction by using transactionId as a Path Variable in the following endpoint:

Request Endpoint

GET {{baseUrl}}/partners-int/accounts/transactions/pix/:transactionId

Path Parameters

As previously mentioned, this endpoint does not use a request body. Instead, it requires the transactionId as a Path Variable, as outlined below:

By executing this endpoint, you can view the details of a specific transaction.

2. Get Multiple Transactions using transactionOrderId and Date Filters

This operation is intended to list all transactions associated with an orderId and within a specified date range. To perform this query, you will use Query Parameters.

Request Endpoint

GET {{baseUrl}}/partners-int/accounts/transactions/pix

3. Retrieve transactions from a specific account (multi-account support)

With the multi-account support (see more in Accounts), you can now specify the account parameter to filter transactions by a specific account. If not provided, only transactions from the account associated with the current API Key will be returned. You may pass:

• a specific account UID (e.g. 1ac29487-1a20-455d-8a47-1b6c0752ae98), or
• all to search across all accounts

Request Example

curl --request GET \
     --url "https://api.sandbox.paybrokers.com/v1/partners-int/accounts/transactions/pix?startDate=2025-03-22T00:00:00.000Z&endDate=2025-03-23T00:00:00.000Z&dataset.limit=50&dataset.offset=0&account=all" \
     --header 'accept: application/json'

curl --request GET \
     --url "https://api.sandbox.paybrokers.com/v1/partners-int/accounts/transactions/pix?startDate=2025-03-22T00:00:00.000Z&endDate=2025-03-23T00:00:00.000Z&account=1ac29487-1a20-455d-8a47-1b6c0752ae98" \
     --header 'accept: application/json'

Query Parameters

Similar to the previous endpoint, this one does not require a request body. Instead, the filters are applied via Query Parameters. These parameters are as follows:

Sucess Response Fields

The responses for both cases contain a significant amount of data. To interpret them correctly, it is important to understand the meaning of each field. Refer to the table below for detailed field descriptions: