Saltar al contenido principal
POST
Crear transacción saliente (Brasil)

Autorizaciones

Authorization
string
header
requerido

Token de autenticación de API de usuario con formato cash_<64-char-hex>. Valor de ejemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Cuerpo

application/json

Solicitud para crear una transacción de salida (retiro) para cuentas BRL de Brasil

accountId
string<uuid>
requerido
amount
number<decimal>
requerido
name
string
requerido

Nombre del destinatario

keyType
enum<string>
requerido

Tipo de clave PIX (document=CPF, evp=clave aleatoria)

Opciones disponibles:
document,
email,
evp,
phone,
cnpj
keyPix
string
requerido

Valor de la clave PIX (email, CPF, CNPJ, teléfono o clave aleatoria)

webhookUrl
string<uri>

Respuesta

Transacción creada. Devuelve status: processing cuando el proveedor aceptó el retiro (HTTP 200). Devuelve status: cancelled cuando el proveedor rechazó o falló (no 200); la transacción se almacena y se marca como cancelada.

id
string<uuid>
requerido

ID de transacción HG.Cash

status
enum<string>
requerido
  • processing: El proveedor aceptó el retiro (HTTP 200). La transacción está siendo procesada.
  • cancelled: El proveedor rechazó o falló (no 200). La transacción fue marcada como cancelada.
Opciones disponibles:
processing,
cancelled