Skip to main content
GET
List PIX transactions

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

account_id
string

Filter by the Midaz alias the row carries (the debited account on a refund, @pi_{ispb} for an indirect).

Example:

"@pagador"

end_to_end_id
string

Filter by the SPI end-to-end id.

Example:

"E1234567890"

status
string

Filter by eTransactionStatus name.

Example:

"EXECUTED"

is_refund
string

Filter by refund flag ('true'/'false').

Example:

"false"

ispb
string

The ISPB of the direct participant whose transactions are listed. OPTIONAL: omit it and the listing is not narrowed by participant, exactly as before. Named, only transactions booked in that participant's books come back - which includes those of the indirect participants it serves. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply: it narrows what comes back and never widens what your token can reach, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

indirectId
string<uuid>

The registered indirect participant (UUID) whose transactions are listed. OPTIONAL: omit it and the listing is not narrowed by indirect. Named, only transactions recorded for that indirect come back - never the direct participant's own. A token confined to one indirect has to name it here.

Example:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Response

OK

data
object[] | null
required

The list of transactions.