Skip to main content
GET
List transactions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
string
default:0

Number of transactions to skip. Starts at 0.

status
string

Filters by status. Repeat the parameter to combine values, or use all for every status.

transactionId
string

Filters by transaction identifier.

paymentMethod
enum<string>

Filters by payment method.

Available options:
pix,
credit_card,
boleto
initialDate
string

Start of the period, as YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.

finalDate
string

End of the period, as YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.

email
string

Filters by the payer's email address.

phone
string

Filters by the payer's phone number.

document
string

Filters by the payer's CPF or CNPJ.

name
string

Filters by the payer's name.

Response

Transactions of the account.

success
boolean
data
object[]
totalRows
integer

Total number of transactions matching the filter.