Skip to main content

​
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

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

​
Example request

The transaction starts in pending and moves to done when the PIX payment is confirmed. When payment is confirmed, HG.Cash posts an account-movement webhook (topic TRANSACTION, eventType status_change) to the request webhookUrl or your default webhook URL. If the movement stores a PIX end-to-end id, that body includes endToEndId. The field is omitted when the id is absent or empty. See PIX end-to-end id.

​
Account status

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