Transaction Query

The transactions are queried using the GET /transaction method by providing the following parameters:

Parameter	Data Type	Description
id	uuid	Filter transactions by transaction ID
created_at_from	date	Filter transactions from a specific date onwards
created_at_to	date	Filter transactions up to a specific date
settled_at_from	date	Filter transactions from a specific settlement date onwards
settled_at_to	date	Filter transactions up to a specific settlement date
currency	string	Filter transactions with a specific currency
greater_than_or_equal_to	string	Filter transactions with main amounts greater than or equal to the specified value
less_than_or_equal_to	string	Filter transactions with main amounts less than or equal to the specified value
type	string	Filter transactions by transaction type

Example of transaction query:

GET /transaction

Response example:

{
  "transactions": [
    {
      "id": "96296a5c-0cf4-4025-dbc4-1a53f0a3afc6",
      "type": "pix_out",
      "currency": "brl",
      "amount": 10000,
      "created_at": "2023-06-05T11:26:17.325Z",
      "settled_at": "2023-06-05",
      "parent_id": "ea355ff5-6a2e-a57e-708c-7ab94e79c7f6",    
      "external_id": "our id 1234",
      "metadata": {
        "key": "value"  
      }
    }  
  ]
}