Saltar al contenido principal
POST
Process a Pix Transfer

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id
string

Account ID (UUID format)

X-Purpose
string

Transaction purpose (TRANSFER, INSTANT_PAYMENT_REFUND, WITHDRAWAL for a Pix Saque charge, CHANGE for a Pix Troco charge). Defaults to TRANSFER.

Cuerpo

application/octet-stream

The body is of type file.

Respuesta

Created

accountId
string
requerido
Ejemplo:

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

amount
string
requerido
Ejemplo:

"100.50"

createdAt
string
requerido
Ejemplo:

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

endToEndId
string
requerido
Ejemplo:

"E1234567820240101000001234567890"

id
string
requerido
Ejemplo:

"550e8400-e29b-41d4-a716-446655440010"

initiationType
enum<string>
requerido
Opciones disponibles:
MANUAL,
KEY,
QR_CODE
Ejemplo:

"KEY"

paymentType
enum<string>
requerido
Opciones disponibles:
IMMEDIATE,
SCHEDULED
Ejemplo:

"IMMEDIATE"

purpose
enum<string>
requerido
Opciones disponibles:
TRANSFER,
INSTANT_PAYMENT_REFUND,
CHANGE,
WITHDRAWAL
Ejemplo:

"TRANSFER"

status
enum<string>
requerido
Opciones disponibles:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REVERSED
Ejemplo:

"COMPLETED"

type
enum<string>
requerido
Opciones disponibles:
CASHIN,
CASHOUT
Ejemplo:

"CASHIN"

updatedAt
string
requerido
Ejemplo:

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

urgency
enum<string>
requerido
Opciones disponibles:
HIGH,
NORMAL
Ejemplo:

"HIGH"

aliasId
string
Ejemplo:

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

deletedAt
string
description
string
Ejemplo:

"Pix Cashin Transfer"

destination
object
feeCharge
object
initiatedAt
string
Ejemplo:

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

ledger
object
metadata
object
source
object
withdrawal
object