Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Account-Id
string
obrigatório

Unique identifier of the Midaz Ledger Account (UUID format).

X-Idempotency
string

Optional idempotency key for safe retries. Reuse the same value only when retrying the same operation after an unknown outcome.

See Retries and idempotency for details.

X-TTL
integer

Time-to-live in seconds for the idempotency key cache. Defines how long the system remembers a processed request.

See Retries and idempotency for details.

Corpo

application/json
initiationType
enum<string>
obrigatório

Type of transfer initiation. Determines which additional field is required: MANUAL requires destination, KEY requires key, and QR_CODE requires emv.

Opções disponíveis:
MANUAL,
KEY,
QR_CODE
Exemplo:

"MANUAL"

destination
object

Destination account information (required for MANUAL).

key
string

Pix key value (required for KEY type). Can be a CPF, CNPJ, email, phone, or EVP.

Exemplo:

"john.doe@example.com"

emv
string

QR code EMV payload (required for QR_CODE type).

Exemplo:

"00020126...5802BR5913Fulano..."

endToEndId
string

Optional custom end-to-end ID (32-character alphanumeric string, auto-generated if not provided).

Exemplo:

"E1234567820240101000001234567890"

Resposta

Pix cash-out initiation created successfully.

The response includes the X-Idempotency-Replayed header.

If the value is false, the transaction was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

id
string

Unique identifier for this initiation (used as initiationId in process).

Exemplo:

"019c96a0-0c82-7c3d-8dcc-c180868b45c4"

initiationType
enum<string>

Type of initiation.

Opções disponíveis:
MANUAL,
KEY,
QR_CODE
Exemplo:

"KEY"

emv
string

EMV payload from the QR code (only for QR_CODE type).

Exemplo:

"00020126...5802BR5913Fulano..."

endToEndId
string

End-to-end identifier for this transfer.

Exemplo:

"E1234567820240101000001234567890"

qrCodeDetails
object

Decoded QR code details (only for QR_CODE type). The shape varies by QR type (static, immediate, or due-date collection).

destination
object

Account party (source or destination) information.

expiresAt
string<date-time>

Date-time when the initiation expires and can no longer be processed.

Exemplo:

"2024-01-15T11:00:00Z"

createdAt
string<date-time>
Exemplo:

"2024-01-15T10:30:00Z"

updatedAt
string<date-time>
Exemplo:

"2024-01-15T10:30:00Z"