Send a PIX payment (PIX-OUT)

Sends BRL from your balance to a PIX key or a PIX copy and paste code. The result arrives later through the callback at baasPostbackUrl (paid or canceled). If cancelled, the amount returns to your balance.

Live credentials only (sandbox returns 403).

Rate limits: one request per minute per source IP, and one withdrawal attempt per account every 60 seconds. The 60 second lock starts on every request that passes authentication, including requests that later fail balance or validation checks.

There is no idempotency key. If a request times out, check the balance and your callbacks before sending again.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Your API token. Live token, or sandbox token (prefix tk_test_) where sandbox is supported.

string
required

Your API secret. Live secret, or sandbox secret (prefix sk_test_) where sandbox is supported.

number
required

Amount in BRL. Platform minimum, maximum and daily count limits apply.

string

Destination PIX key. Required unless pixQrCode is sent.

string
enum

Key type. Required unless pixQrCode is sent. telefone is a phone key, aleatoria is a random (EVP) key. CNPJ keys are not listed.

Allowed:
string | null

PIX copy and paste code to pay instead of a key. Support depends on the acquirer serving your account.

string
required

URL that receives the PIX-OUT callback.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json