Skip to main content
POST
/
br
/
transactions
/
inbound
Create Inbound Transaction (Brazil)
curl --request POST \
  --url https://hg.cash/api/v1/br/transactions/inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "email": "jsmith@example.com",
  "webhookUrl": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "qrCode": "<string>",
  "pixCopiaECola": "<string>"
}

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.

Authorizations

​
Authorization
string
header
required

User API authentication token with format: cash_<64-char-hex>

Example: cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2

Body

application/json

Request to create an inbound transaction (receive payment) for Brazil BRL accounts

​
accountId
string<uuid>
required

ID of the account to receive funds into

​
amount
number<decimal>
required

Amount to receive (positive)

​
email
string<email>
required

Payer email for the charge

​
webhookUrl
string<uri>

Optional URL to receive status updates

Response

Transaction created

​
id
string<uuid>
required

HG.Cash transaction ID

​
status
enum<string>
required
Available options:
pending
​
qrCode
string

QR code string for the payer to scan (base64 or PIX string)

​
pixCopiaECola
string

PIX copy-paste string (alternative to QR code)