Iniciar una transferencia Pix
Usa este endpoint para iniciar un cash-out Pix creando un registro de iniciación. Este endpoint recupera y valida la información de destino sin mover fondos.
Notas:
-
Este endpoint admite tres tipos de iniciación: MANUAL (datos completos de la cuenta), KEY (usando una clave Pix) y QR_CODE (usando un código QR).
-
Para la iniciación KEY, el plugin consulta el servicio DICT para recuperar la información de la cuenta de destino.
-
Para la iniciación QR_CODE, el plugin decodifica el código QR y consulta el servicio DICT para recuperar la información de la cuenta de destino.
-
La iniciación no mueve fondos: solo valida y prepara la transferencia.
-
Tras una iniciación exitosa, usa el endpoint Process para completar la transferencia.
Autorizaciones
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Encabezados
Identificador único de la cuenta del Ledger de Midaz (formato UUID).
Clave de idempotencia opcional para reintentos seguros. Reutiliza el mismo valor solo cuando reintentas la misma operación tras un resultado desconocido.
Consulta Reintentos e idempotencia para más detalles.
Tiempo de vida en segundos para la caché de la clave de idempotencia. Define cuánto tiempo el sistema recuerda una solicitud procesada.
Consulta Reintentos e idempotencia para más detalles.
Cuerpo
Tipo de iniciación de la transferencia. Determina qué campo adicional
es obligatorio: MANUAL requiere destination, KEY requiere key y
QR_CODE requiere emv.
MANUAL, KEY, QR_CODE "MANUAL"
Información de la cuenta de destino (obligatoria para MANUAL).
Valor de la clave Pix (obligatorio para el tipo KEY). Puede ser un CPF, CNPJ, correo electrónico, teléfono o EVP.
"john.doe@example.com"
Payload EMV del código QR (obligatorio para el tipo QR_CODE).
"00020126...5802BR5913Fulano..."
ID de extremo a extremo personalizado opcional (cadena alfanumérica de 32 caracteres, se genera automáticamente si no se proporciona).
"E1234567820240101000001234567890"
Respuesta
Iniciación del cash-out Pix creada correctamente.
La respuesta incluye el encabezado X-Idempotency-Replayed.
Si el valor es false, la transacción se acaba de procesar. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.
Consulta Reintentos e idempotencia para obtener más detalles.
Identificador único de esta iniciación (se utiliza como initiationId en el proceso).
"019c96a0-0c82-7c3d-8dcc-c180868b45c4"
Tipo de iniciación.
MANUAL, KEY, QR_CODE "KEY"
Payload EMV del código QR (solo para el tipo QR_CODE).
"00020126...5802BR5913Fulano..."
Identificador de extremo a extremo de esta transferencia.
"E1234567820240101000001234567890"
Detalles decodificados del código QR (solo para el tipo QR_CODE).
La estructura varía según el tipo de QR (estático, inmediato o cobro
con vencimiento).
Información de la parte de la cuenta (origen o destino).
Fecha y hora en que la iniciación expira y ya no puede procesarse.
"2024-01-15T11:00:00Z"
"2024-01-15T10:30:00Z"
"2024-01-15T10:30:00Z"