Transaction Status

This method allows querying past transactions. Either date or reference is required, but both parameters are optional.

Note: The service returns transactions occurring within a maximum of 90 days from the current date.

Params (before JWT-encoding)

Parameter	Type	Description
reference	(optional, string array)	The 'reference' parameter represents a past reference provided by the merchant. Multiple values can be accepted.
status	(optional, string)	The 'status' parameter indicates the status of the transactions to search. Possible values include 'Pending', 'Completed', and 'Canceled'.
date	(optional, string array)	The 'date' parameter specifies the date or date range to query. It should be sent as an array containing 1 or 2 values: one element for a single date and two elements for a range. Dates should be formatted as yyyy-MM-dd.

{
  "iat": 1712175617,
  "exp": 1712175677,
  "data": {
    "reference": ["123", "456"],
    "status": "Pending",
    "date": ["2024-01-01", "2024-30-01"]
  }
}

When querying a transaction with the 'canceled' status, a reason from the provided list is included in the response.

View the list of cancellation reasons here.

Example Response (after JWT-decoding)

{
  "iat": 1712256589,
  "exp": 1712256649,
  "code": 200,
  "data": {
    "results": [
      {
        "created_at": "2024-01-16",
        "transfer_id": "102054",
        "reference": "sss",
        "type": "Gateway Out",
        "original_amount": "5.00",
        "fee_amount": "0.04",
        "user_id": "999417",
        "original_currency": "BRL",
        "merchant_amount": "1.56",
        "merchant_currency": "EUR",
        "status": "Pending",
        "payment_method": "Pix",
        "reason_code": null,
        "reason": null,
        "psp_message": null
      }
    ]
  }
}