Processar uma Transferência Pix
Use este endpoint para processar um cash-out Pix iniciado anteriormente e movimentar fundos entre contas.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
Identificador único da Conta do Ledger Midaz (formato UUID).
Finalidade da transação para o cash-out. Assume TRANSFER quando omitido.
TRANSFER, CHANGE, WITHDRAWAL, REFUND_AUTOMATIC_PIX, INSTANT_PAYMENT_REFUND, INSTALLMENT_PIX 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.
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
ID de iniciação obtido na etapa de iniciação.
"019c96a0-0c82-7c3d-8dcc-c180868b45c4"
Valor da transferência em BRL (formato 0.00). Para QR codes com valor
fixo, deve corresponder ao valor codificado no QR code.
"100.50"
Descrição ou mensagem opcional.
140"Pagamento por serviços"
Atributos personalizados de chave-valor para esta transferência. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.
Resposta
Transferência Pix processada 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.
Identificador único da transferência.
"019c96a0-0c21-71f9-a487-66a1258278a1"
Identificador end-to-end.
"E123456789BR1234567890123456789"
Valor da transferência em BRL (formato 0.00).
"100.00"
Status da transferência.
CREATED, PENDING, PROCESSING, COMPLETED, FAILED, REVERSED "COMPLETED"
Tipo de transferência.
CASHOUT, CASHIN "CASHOUT"
Descrição ou mensagem opcional.
140"Pix Cashout Transfer"
Informações da parte da conta (origem ou destino).
Informações da parte da conta (origem ou destino).
Tipo de pagamento.
IMMEDIATE, SCHEDULED "IMMEDIATE"
Tipo de iniciação.
MANUAL, KEY, QR_CODE "KEY"
Urgência da transferência.
HIGH, NORMAL "HIGH"
Tipo de finalidade da transação. O padrão é TRANSFER.
TRANSFER, INSTANT_PAYMENT_REFUND "TRANSFER"
Identificador da conta (UUID).
"01989f9e-6508-79f8-9540-835be49fbd0d"
Identificador do alias (UUID).
"01989f9e-6508-79f8-9540-835be49fbd0e"
Timestamp de iniciação (ISO 8601 UTC).
"2024-01-15T10:30:00Z"
"2024-01-15T10:30:00Z"
"2024-01-15T10:30:00Z"
Identificadores de transação e operação do ledger Midaz.
Atributos personalizados de chave-valor associados a esta transferência. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.
Detalhes do cálculo de tarifas (se aplicável).

