Saltar al contenido principal
POST
/
v1
/
transfers
/
cashout
/
process
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 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
​
initiationId
string
requerido

ID de iniciación del paso de inicio.

Ejemplo:

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

Respuesta

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

​
id
string

Identificador único de la transferencia.

Ejemplo:

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

​
endToEndId
string

Identificador end-to-end.

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"