Saltar al contenido principal
POST
/
v1
/
transfers
/
cashout
/
initiate
Iniciar una Transferencia Pix
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "type": "KEY",
  "amount": "100.00",
  "key": "john.doe@example.com",
  "description": "Pago por servicios"
}
'
{
  "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4",
  "destination": {}
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la Cuenta del Ledger Midaz (formato UUID).

​
X-Idempotency
string

Clave de idempotencia opcional para reintentos seguros. Si se omite, el servidor puede generar una automáticamente a partir del hash del cuerpo de la solicitud.

Consulte Reintentos e idempotencia para más detalles.

​
X-TTL
integer

Tiempo de vida en segundos para el caché de la clave de idempotencia. Define cuánto tiempo el sistema recuerda una solicitud procesada.

Consulte Reintentos e idempotencia para más detalles.

Cuerpo

application/json
​
type
enum<string>
requerido

Tipo de iniciación.

Opciones disponibles:
MANUAL,
KEY,
QR_CODE
Ejemplo:

"KEY"

​
amount
string
requerido

Monto de la transferencia.

Ejemplo:

"100.00"

​
key
string

Clave Pix (requerida para tipo KEY).

Ejemplo:

"john.doe@example.com"

​
emv
string

Payload EMV del Código QR (requerido para tipo QR_CODE).

​
description
string

Descripción de la transferencia.

Ejemplo:

"Pago por servicios"

Respuesta

Iniciación de cash-out Pix creada exitosamente.

La respuesta incluye el header X-Idempotency-Replayed.

Si el valor es false, la transacción fue recién procesada. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.

Consulte Reintentos e idempotencia para más detalles.

​
initiationId
string

ID de iniciación a usar en el proceso.

Ejemplo:

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

​
destination
object

Información de destino validada.