PIX cash-in - HG.Cash

Overview

Brazil cash-in creates a PIX charge for a BRL account. The API returns a QR code and/or PIX copy-paste string for the payer. The transaction stays pending until payment is confirmed. Accounts must use currency BRL and country BR.

Prerequisites

Bearer API token with access to the BRL account
Payer email on the charge (required by the API)
Payer document — CPF or CNPJ (required by the API)

Flow

POST /api/v1/br/transactions/inbound — pass accountId, amount, email, and document
Present qrCode or pixCopiaECola to the payer
Optionally poll GET /api/v1/br/transactions/{id}/status or set webhookUrl (see Receiving webhooks)

Example request

curl -X POST https://hg.cash/api/v1/br/transactions/inbound \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "YOUR_ACCOUNT_UUID",
    "amount": 250.00,
    "email": "payer@example.com",
    "document": "12345678901",
    "webhookUrl": "https://your.app/webhooks/hg"
  }'

The transaction starts in pending and moves to done when the PIX payment is confirmed.

Account status

The source account must be Operativa. Requests against Bloqueada or Cerrada accounts return 403 with code: ACCOUNT_NOT_OPERATIVE.