Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-22252442.9 KB
Brazil

Create Outbound Transaction (Brazil)

Create an outbound transaction (withdraw) from a Brazil (BRL) account. Requires sufficient net balance. Transaction starts in processing status.

post/br/transactions/outbound

Request body

accountIdstring uuid required
amountnumber required
namestring required

Recipient name

keyType'document' | 'email' | 'evp' | 'phone' | 'cnpj' required

PIX key type (document=CPF, evp=random key)

keyPixstring required

PIX key value (email, CPF, CNPJ, phone, or random key)

webhookUrlstring uri

Response

Transaction created. Returns status: processing when the provider accepted the withdraw (HTTP 200). Returns status: cancelled when the provider rejected or failed (non-200); the transaction is stored and marked cancelled.

idstring uuid required

HG.Cash transaction ID

status'processing' | 'cancelled' required
  • processing: Provider accepted the withdraw (HTTP 200). Transaction is being processed.
  • cancelled: Provider rejected or failed (non-200). Transaction was marked cancelled.