Skip to main content
POST
Creates a transfer or withdrawal via Pix.

Body parameters

string
required
Transfer identifier in your application.
number
required
Transfer amount in BRL.
boolean
If false, the withdrawal fee is not deducted from the receiver.
object
required
Receiver Pix key data.
enum
required
Pix key type. Supported values include cpf, cnpj, email, phone, and random.
string
required
Receiver Pix key.
object
required
Account owner information.
string
required
IPv4 of the user performing the transfer. It must be different from the application IP.
string
required
Account owner’s name, without accents.
object
required
Account owner’s document.
enum
required
Document type. Supported values include cpf and cnpj.
string
required
Document number.
string
required
URL for transfer update notifications.

Request example

Payload example

Response

string
required
Token used to validate transfer webhook notifications.
object
required
Withdrawal information.
object
required
Payout account information.
string
Withdrawal receipt URL.