PixRequestScheduleResponseDTO
- amountType: number
Amount.
- createdType: string
At Creation timestamp in ISO-8601 format.
- endType: string
To End Id End-to-end identifier carried through to the SPI execution.
- idType: string
Identifier (UUID).
- initiationType: string enum
Method Payment 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
- installmentType: integer Format: int32
Installment number within the parent recurrence (1-based). Always 1 for standalone schedules.
- msgType: string
Id BizMsgIdr da mensagem pacs.002 recebida do BACEN após liquidação.
- priorityType: string enum
Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)
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 outgoing 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 · ReceiverDTO
Receiver/beneficiary information for the Pix transaction
- documentType: object · DocumentDTOrequired
Document identification (CPF or CNPJ)
- nameType: stringmin length:1required
Receiver full name.
- accountType: object · AccountDTO
Bank account information
- keyType: string
Receiver Pix key.
- reconciliationType: string
Id Client reconciliation identifier for reporting and matching.
- recurrenceType: string
Id Parent recurrence identifier (UUID). NULL for standalone schedules.
- scheduledType: string Format: date
Date Date when this schedule will be executed (yyyy-MM-dd).
- senderType: object · SenderDTO
Payer/sender information for the Pix transaction
- accountType: object · AccountDTOrequired
Bank account information
- documentType: object · DocumentDTOrequired
Document identification (CPF or CNPJ)
- nameType: stringmin length:1required
Participant full name.
- settledType: string Format: date-time
At Timestamp de liquidação (FctvIntrBkSttlmDt) da mensagem pacs.002 do BACEN.
- sourceType: string enum
Origin.
values- M
A N U A L - P
I X _ A U T O M A T I C
- statusType: string enum
Status.
values- A
C T I V E - I
N A C T I V E - C
O M P L E T E D - R
E J E C T E D - E
X P I R E D - P
E N D I N G
- totalType: number
Amount Total Amount. Tax and fees included
- totalType: integer Format: int32
Installments Total installments planned by the parent recurrence. NULL for standalone or open-ended recurrences.
- updatedType: string
At Update timestamp in ISO-8601 format.
- userType: string
Description User-provided description.