Saltar al contenido principal
POST
Crear transacción entrante (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 entrante (cobro) en cuentas BRL de Brasil

accountId
string<uuid>
requerido

ID de la cuenta que recibirá los fondos

amount
number<decimal>
requerido

Monto a cobrar (positivo)

email
string<email>
requerido

Email del pagador para el cobro

document
string
requerido

CPF o CNPJ del pagador (solo dígitos, o con puntuación)

webhookUrl
string<uri>

URL opcional para recibir actualizaciones de estado

Respuesta

Transacción creada

id
string<uuid>
requerido

ID de transacción HG.Cash

status
enum<string>
requerido
Opciones disponibles:
pending
qrCode
string

Cadena de código QR para que el pagador la escanee (base64 o cadena PIX)

pixCopiaECola
string

Cadena PIX copiar y pegar (alternativa al código QR)