PixRequestListItemDto
Summary data of a Pix transaction
- accountType: string
Balance Block Id Account balance block identifier
- agentType: string
Modality - amountType: number
Transaction amount in BRL
- cashType: number
Amount - cashierType: string
Ispb - createdType: string Format: date-time
At the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- 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
- keyType: string
Metadata key
- valueType: string
Metadata value
- 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
- accountType: object · AccountDTO1
Bank account information
- documentType: object · DocumentDTO1
Document identification (CPF or CNPJ)
- keyType: string
Receiver Pix key.
- nameType: string
Receiver full name.
- returnType: string
Reason - senderType: object · SenderDTO1
Payer/sender information for the Pix transaction
- accountType: object · AccountDTO1
Bank account information
- documentType: object · DocumentDTO1
Document identification (CPF or CNPJ)
- nameType: string
Participant full name.
- settledType: string Format: date-time
At Transaction creation timestamp
- 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 · PixRequestTypeenum
Type Pix transaction type
values- P
I X _ R E Q U E S T _ I N - P
I X _ R E Q U E S T _ O U T - P
I X _ R E F U N D _ I N - P
I X _ R E F U N D _ O U T
- txType: string
Id Transaction identifier for reconciliation
- updatedType: string Format: date-time
At Last update timestamp
- userType: string
Description Description provided by the payer