PixRequestListItemPageResponse
Paginated Pix transactions response
- hasType: boolean
Next Indicates whether a next page exists
- itemsType: array object[] · PixRequestListItemDto[]
List of Pix transactions on the current page
Summary data of a Pix transaction
- accountType: string
Balance Block Id Account balance block identifier
- amountType: number
Transaction amount in BRL
- createdType: string Format: date-time
At Transaction creation timestamp
- endType: string
To End Id End-to-end identifier in the SPI
- failureType: string
Reason Reason for transaction failure, when applicable
- idType: string Format: uuid
Unique transaction identifier
- initiationType: string enum
Method Pix initiation method
values- A
P D N - A
P E S - A
U T O - D
I C T - I
N I C - M
A N U - Q
R D N - Q
R E S
- metadataType: array object[] · MetadataDTO1[]
Optional list of key/value metadata items stored with the transaction
Key/value metadata item
- msgType: string
Id SPI message identifier
- originalType: string
End To End Id Original payment end-to-end ID (for refunds)
- priorityType: string enum
Payment priority level
values- H
I G H - N
O R M
- priorityType: string enum
Type Priority type code (BACEN SPI)
values- P
A G A G D - P
A G F R D - P
A G P R I
- purposeType: string enum
Purpose of the Pix payment (SPI purpose codes)
values- G
S C B - I
P A Y - I
P R T - O
T H R - R
E F U
- receiverType: object · ReceiverDTO1
Receiver/beneficiary information for the Pix transaction
- senderType: object · SenderDTO1
Payer/sender information for the Pix transaction
- statusType: string enum
Pix transaction status
values- R
E C E I V E D - A
C C E P T E D - S
E T T L E D - R
E J E C T E D - C
A N C E L E D - F
A I L E D
- transactionType: string
Type Transaction type (PIX_REQUEST_IN or PIX_REQUEST_OUT)
- txType: string
Id Transaction identifier for reconciliation
- updatedType: string Format: date-time
At Last update timestamp
- userType: string
Description Description provided by the payer
- pageType: integer Format: int32
Current page number (zero-based)
- sizeType: integer Format: int32
Number of records per page
- totalType: integer Format: int64
Items Total number of records matching the query
- totalType: integer Format: int32
Pages Total number of pages available