Procesar una transferencia Pix

curl --request POST \ --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Account-Id: <x-account-id>' \ --data ' { "initiationId": "019c96a0-0c82-7c3d-8dcc-c180868b45c4" } '

{ "id": "019c96a0-0c21-71f9-a487-66a1258278a1", "endToEndId": "E123456789BR1234567890123456789", "amount": "100.00", "status": "COMPLETED", "type": "CASHOUT", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:30:00Z" }

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 de Midaz (formato UUID).

X-Purpose

enum<string>

predeterminado:TRANSFER

Propósito de la transacción para el cash-out. Su valor predeterminado es TRANSFER cuando se omite.

Opciones disponibles:

TRANSFER,

CHANGE,

WITHDRAWAL,

REFUND_AUTOMATIC_PIX,

INSTANT_PAYMENT_REFUND,

INSTALLMENT_PIX

X-Idempotency

string

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.

X-TTL

integer

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

application/json

initiationId

string

requerido

ID de inicio obtenido en el paso de inicio.

Ejemplo:

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

Respuesta

Transferencia Pix procesada 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.

string

Identificador único de la transferencia.

Ejemplo:

"019c96a0-0c21-71f9-a487-66a1258278a1"

endToEndId

string

Identificador de extremo a extremo.

Ejemplo:

"E123456789BR1234567890123456789"

amount

string

Monto de la transferencia.

Ejemplo:

"100.00"

status

enum<string>

Estado de la transferencia.

Opciones disponibles:

PENDING,

PROCESSING,

COMPLETED,

FAILED,

CANCELLED

Ejemplo:

"COMPLETED"

type

enum<string>

Tipo de transferencia.

Opciones disponibles:

CASHOUT,

CASHIN

Ejemplo:

"CASHOUT"

createdAt

string<date-time>

Ejemplo:

"2024-01-15T10:30:00Z"

updatedAt

string<date-time>

Ejemplo:

"2024-01-15T10:30:00Z"