Iniciar uma Transferência Pix
Use este endpoint para iniciar um cash-out Pix criando um registro de iniciação. Este endpoint recupera e valida as informações de destino sem movimentar fundos.
Notas:
-
Este endpoint suporta três tipos de iniciação: MANUAL (dados completos da conta), KEY (usando uma chave Pix) e QR_CODE (usando um QR Code).
-
Para a iniciação KEY, o plugin consulta o serviço DICT para recuperar as informações da conta de destino.
-
Para a iniciação QR_CODE, o plugin decodifica o QR Code e consulta o serviço DICT para recuperar as informações da conta de destino.
-
A iniciação não movimenta fundos - ela apenas valida e prepara a transferência.
-
Após a iniciação bem-sucedida, use o endpoint Process para concluir a transferência.
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).
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
Tipo de iniciação da transferência. Determina qual campo adicional é
obrigatório: MANUAL exige destination, KEY exige key e
QR_CODE exige emv.
MANUAL, KEY, QR_CODE "MANUAL"
Informações da conta de destino (obrigatório para MANUAL).
Valor da chave Pix (obrigatório para o tipo KEY). Pode ser CPF, CNPJ, e-mail, telefone ou EVP.
"john.doe@example.com"
Payload EMV do QR code (obrigatório para o tipo QR_CODE).
"00020126...5802BR5913Fulano..."
ID end-to-end personalizado opcional (string alfanumérica de 32 caracteres, gerada automaticamente se não fornecida).
"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.
Identificador único desta iniciação (usado como initiationId no processamento).
"019c96a0-0c82-7c3d-8dcc-c180868b45c4"
Tipo de iniciação.
MANUAL, KEY, QR_CODE "KEY"
Payload EMV do QR code (somente para o tipo QR_CODE).
"00020126...5802BR5913Fulano..."
Identificador end-to-end desta transferência.
"E1234567820240101000001234567890"
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).
Informações da parte da conta (origem ou destino).
Data-hora em que a iniciação expira e não pode mais ser processada.
"2024-01-15T11:00:00Z"
"2024-01-15T10:30:00Z"
"2024-01-15T10:30:00Z"

