Skip to main content
GET
Obtener un payout

Autorizaciones

Authorization
string
header
requerido

JWT de sesión (de register/login) o llave de API (pk_...). X-API-Key: <token> se acepta como header alternativo.

Parámetros de ruta

payoutID
string<uuid>
requerido

Respuesta

El payout.

payout_id
string<uuid>
account_id
string<uuid>
idempotency_key
string
country
string
currency
string
method
string
local_amount
string
fx_rate
string

La tasa de tu cuenta al momento de la ejecución (unidades locales por 1 USDT).

rate_source
enum<string>

Origen de la tasa ejecutada. lot, blend o spot; se omite en filas históricas sin atribución.

Opciones disponibles:
lot,
blend,
spot
usdt_amount
string
fee
string
total_debit
string
settlement_asset
enum<string>

Saldo virtual desde el que realmente se debitó la operación.

Opciones disponibles:
USD,
USDT,
USDC,
BTC,
GOLD,
SILVER,
PLATINUM
settlement_amount
string

Monto exacto debitado del saldo del asset de settlement (en unidades de ese asset). Es igual a total_debit cuando el asset es USDT. Si el payout falla se reembolsa este monto exacto — nunca se re-cotiza.

settlement_rate
string

Precio USD efectivo por unidad del asset de settlement usado para convertir el total en USDT ("1" para USDT/USDC).

beneficiary
object
description
string
status
enum<string>

pending con compliance_pending: true significa que el screening técnico del beneficiario espera antes de cualquier débito o despacho al core. Después del screening, pending también puede usar compliance_dispatch_pending, compliance_dispatching o core_unreachable mientras el débito permanece retenido.

Opciones disponibles:
pending,
processing,
completed,
failed
status_code
string

Detalle del estado normalizado. compliance_pending es pre-débito; compliance_dispatch_pending, compliance_dispatching y core_unreachable son códigos durables de transición después del screening.

status_message
string
funds_debited
boolean

Falso antes de debitar un payout pendiente de screening. Verdadero después de que el screening pasa y existe el débito/hold, incluso durante las transiciones de despacho.

predebit_failure
boolean

True cuando el screening o un control duro terminó el payout antes de cualquier débito. Es distinto de un payout fallido cuyo débito se reembolsó después.

compliance_pending
boolean

Verdadero solo mientras el screening técnico espera antes de cualquier débito o despacho al core; pasa a falso cuando se acepta el resultado process.

bank_reference
string

Referencia de la transaccion en el banco/rail (ej. el id de transferencia del banco, con el que el beneficiario cruza el pago con su banco). En US ACH/wire/SWIFT es la referencia CBF que vuelve al crear; en el resto de corredores queda vacia hasta que el rail la reporta.

uetr
string

Identificador UETR/SWIFT gpi reportado por el banco después de la ejecución; vacío hasta estar disponible.

imad
string

Identificador doméstico wire/ACH reportado por el banco después de la ejecución; vacío hasta estar disponible.

created_at
string<date-time>
updated_at
string<date-time>
idempotency_hit
boolean

Presente (true) cuando la respuesta es una repetición idempotente.

receipt_url
string<uri>

Presente solo cuando existe un comprobante, normalmente después del débito y del estado final. Se omite mientras el payout espera screening técnico antes del débito.