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

Identificador único da Conta do Ledger Midaz (formato UUID).

X-Idempotency
string

Chave de idempotência opcional para repetições seguras. Reutilize o mesmo valor apenas ao repetir a mesma operação após um resultado desconhecido.

Consulte Repetições e idempotência para mais detalhes.

X-TTL
integer

Tempo de vida (time-to-live), em segundos, para o cache da chave de idempotência. Define por quanto tempo o sistema lembra de uma requisição processada.

Consulte Repetições e idempotência para mais detalhes.

Corpo

application/json
initiationType
enum<string>
obrigatório

Tipo de iniciação da transferência. Determina qual campo adicional é obrigatório: MANUAL exige destination, KEY exige key e QR_CODE exige emv.

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

"MANUAL"

destination
object

Informações da conta de destino (obrigatório para MANUAL).

key
string

Valor da chave Pix (obrigatório para o tipo KEY). Pode ser CPF, CNPJ, e-mail, telefone ou EVP.

Exemplo:

"john.doe@example.com"

emv
string

Payload EMV do QR code (obrigatório para o tipo QR_CODE).

Exemplo:

"00020126...5802BR5913Fulano..."

endToEndId
string

ID end-to-end personalizado opcional (string alfanumérica de 32 caracteres, gerada automaticamente se não fornecida).

Exemplo:

"E1234567820240101000001234567890"

Resposta

Iniciação de cash-out Pix criada com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a transação acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

id
string

Identificador único desta iniciação (usado como initiationId no processamento).

Exemplo:

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

initiationType
enum<string>

Tipo de iniciação.

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

"KEY"

emv
string

Payload EMV do QR code (somente para o tipo QR_CODE).

Exemplo:

"00020126...5802BR5913Fulano..."

endToEndId
string

Identificador end-to-end desta transferência.

Exemplo:

"E1234567820240101000001234567890"

qrCodeDetails
object

Detalhes decodificados do QR code (somente para o tipo QR_CODE). O formato varia conforme o tipo de QR (estático, imediato ou cobrança com vencimento).

destination
object

Informações da parte da conta (origem ou destino).

expiresAt
string<date-time>

Data-hora em que a iniciação expira e não pode mais ser processada.

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"