Skip to main content

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.

​
Overview

Create outbound bank payouts from Chile CLP accounts via POST /api/v1/cl/transactions/outbound. Requires sufficient net balance (same rules as other outbound APIs). The transaction starts in processing and completes when the payout is successfully settled (done).

​
Required fields (Chile)

  • Beneficiary: beneficiaryFirstName, beneficiaryLastName, email, documentType, documentNumber
  • payoutBeneficiaryTypeCode: person or company
  • Bank: bankName (3-character bank code), accountNumber, payoutAccountTypeCode
  • amount in CLP

​
Status updates

  • Poll: GET /api/v1/cl/transactions/{id}/status
  • Optional webhookUrl on the request for HG → your server notifications (see Receiving webhooks)

​
Payout lifecycle

HG.Cash exposes normalized statuses (pending, processing, done, cancelled, failed). Use polling or your webhook handler to react to status changes.