Skip to main content
POST
Create Inbound Transaction (Brazil)

Authorizations

Authorization
string
header
required

User API authentication token with format cash_<64-char-hex>. Sample value 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)