Saltar al contenido principal
POST
Procesar una transferencia Pix

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"

amount
string
requerido

Monto de la transferencia en BRL (formato 0.00). Para códigos QR con un monto fijo, este debe coincidir con el monto codificado en el código QR.

Ejemplo:

"100.50"

description
string

Descripción o mensaje opcional.

Maximum string length: 140
Ejemplo:

"Payment for services"

metadata
object

Atributos personalizados de clave-valor para esta transferencia. Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo 2000 caracteres.

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.

id
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 en BRL (formato 0.00).

Ejemplo:

"100.00"

status
enum<string>

Estado de la transferencia.

Opciones disponibles:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REVERSED
Ejemplo:

"COMPLETED"

type
enum<string>

Tipo de transferencia.

Opciones disponibles:
CASHOUT,
CASHIN
Ejemplo:

"CASHOUT"

description
string

Descripción o mensaje opcional.

Maximum string length: 140
Ejemplo:

"Pix Cashout Transfer"

source
object

Información de la parte de la cuenta (origen o destino).

destination
object

Información de la parte de la cuenta (origen o destino).

paymentType
enum<string>

Tipo de pago.

Opciones disponibles:
IMMEDIATE,
SCHEDULED
Ejemplo:

"IMMEDIATE"

initiationType
enum<string>

Tipo de iniciación.

Opciones disponibles:
MANUAL,
KEY,
QR_CODE
Ejemplo:

"KEY"

urgency
enum<string>

Urgencia de la transferencia.

Opciones disponibles:
HIGH,
NORMAL
Ejemplo:

"HIGH"

purpose
enum<string>

Tipo de finalidad de la transacción. El valor predeterminado es TRANSFER.

Opciones disponibles:
TRANSFER,
INSTANT_PAYMENT_REFUND
Ejemplo:

"TRANSFER"

accountId
string

Identificador de la cuenta (UUID).

Ejemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

aliasId
string

Identificador del alias (UUID).

Ejemplo:

"01989f9e-6508-79f8-9540-835be49fbd0e"

initiatedAt
string<date-time>

Marca de tiempo de la iniciación (ISO 8601 UTC).

Ejemplo:

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

createdAt
string<date-time>
Ejemplo:

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

updatedAt
string<date-time>
Ejemplo:

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

ledger
object

Identificadores de transacción y operación del ledger de Midaz.

metadata
object

Atributos personalizados de clave-valor asociados con esta transferencia. Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo 2000 caracteres.

feeCharge
object

Detalles del cálculo de tarifas (si corresponde).