v1

latestOpenAPI 3.1.0MIT2026-07-22252442.9 KB

Brazil

Create Inbound Transaction (Brazil)

Create an inbound transaction to receive a payment. Returns a QR code for the payer to scan. Account must be a Brazil (BRL) account. Transaction starts in pending status until payment is confirmed.

post/br/transactions/inbound

Request body

accountIdstring uuid required

ID of the account to receive funds into

amountnumber required

Amount to receive (positive)

emailstring email required

Payer email for the charge

documentstring required

Payer CPF or CNPJ (digits only, or formatted with punctuation)

webhookUrlstring uri

Optional URL to receive status updates

Response

Transaction created

idstring uuid required

HG.Cash transaction ID

qrCodestring

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

pixCopiaEColastring

PIX copy-paste string (alternative to QR code)

status'pending' required