Skip to main content
POST
Create Outbound 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 outbound transaction (withdraw) for Brazil BRL accounts

accountId
string<uuid>
required
amount
number<decimal>
required
name
string
required

Recipient name

keyType
enum<string>
required

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

Available options:
document,
email,
evp,
phone,
cnpj
keyPix
string
required

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

document
string

Optional recipient CPF or CNPJ (digits only, or formatted with punctuation). Not required. When provided, must be 11 digits (CPF) or 14 digits (CNPJ). Forwarded to the PIX provider when present. Bankizi lists this field as optional on PIX withdraw-by-key; inbound Brazil still requires document (payer CPF/CNPJ).

webhookUrl
string<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.

id
string<uuid>
required

HG.Cash transaction ID

status
enum<string>
required
  • processing: Provider accepted the withdraw (HTTP 200). Transaction is being processed.
  • cancelled: Provider rejected or failed (non-200). Transaction was marked cancelled.
Available options:
processing,
cancelled