Using Pix Key
Considering the fact that a Pix key represents a bank account in the Pix arrangement, this is the most straight forward way to complete a payout using Pix.
The only information you need from the customer is their Pix key. Currently, we support 5 types of keys and we use RegEx to validate the format:
Type
RegEx
Example
^[a-z0-9.!#$&'*+\/=?^_\{\}~-]+@[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)*$
Phone
^\+[1-9][0-9]\d{1,14}$
+5510998765432
CPF (Individual Tax ID)
^[0-9]{11}$
12345678901
CNPJ (Business Tax ID)
^[0-9]{14}$
12345678901234
Random Key
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
123e4567-e89b-12d3-a456-426655440000
Generating a new Payout
When generating a new payout, pay attention to the following parameters (required fields):
bank_account_id (required):
Unique identifier of the bank account associated with the virtual account.
Example: "123"
virtual_account_id (required):
Unique identifier of the virtual account that will send the money.
Example: "456"
amount (required):
Transaction amount in cents.
Example: 10000
currency (required):
Transaction currency.
Example: "BRL"
pix_key (required):
Recipient's Pix key (can be an email, CPF, phone number, etc.).
Example: "[email protected]"
pix_type (required):
Type of Pix key.
Possible values: "key", "brcode", or "manual".
Example: "key"
description (optional):
Transaction description.
Example: "PIX withdrawal"
reference (required):
Unique identifier for idempotency control.
Example: "ref-001"
To generate the payout, send a POST request to our Pix Payout endpoint, using this payload:
Request:
POST https://api.sandbox.aurixpay.ws/banking/v1/cashout/pix
Example Payload:
Responses:
Success (HTTP 201):
Last updated