Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.hg.cash/llms.txt

Use this file to discover all available pages before exploring further.

​
Resumen

Cree transferencias PIX salientes desde cuentas BRL con POST /api/v1/br/transactions/outbound. Requiere saldo neto suficiente. La transacción inicia en processing si es aceptada, o cancelled si no puede crearse.

​
Campos obligatorios

  • accountId, amount
  • name — nombre del beneficiario
  • keyType — document, email, evp, phone o cnpj
  • keyPix — valor de la clave PIX

​
Actualizaciones de estado

​
Ejemplo

curl -X POST https://hg.cash/api/v1/br/transactions/outbound \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "YOUR_ACCOUNT_UUID",
    "amount": 500.00,
    "name": "João Silva",
    "keyType": "email",
    "keyPix": "joao@example.com"
  }'

​
Ciclo del payout

HG.Cash expone estados normalizados (pending, processing, done, cancelled, failed). Use polling o su webhook para reaccionar a los cambios.