Cash Out
PIX Cashout Description
The PIX Cashout allows for making a payment via PIX from a virtual account, using the details provided in the request. This system facilitates the transfer of funds directly to a specific PIX key, which can be an email, CPF, CNPJ, or phone number, depending on the type of key provided.
This feature is ideal for companies or platforms that want to make fast and automatic payments to their users or partners using the instant payment system PIX. Additionally, it allows the inclusion of additional information, such as transaction description and reference, which makes tracking and identifying payments easier.
How PIX Cashout Works
The PIX Cashout is a POST operation made to the following URL:
https://api.aurixpay.ws/banking/v1/cashout/pixBy making a request to this URL, the system initiates a PIX payment using the following data:
Virtual Account Details:
bank_account_id: The ID of the bank account associated with the originating virtual account.
virtual_account_id: The ID of the virtual account from which the money will be transferred.
Amount and Currency:
amount: The transaction amount in cents.
currency: The currency used for the transaction (e.g., "BRL" for Brazilian Real).
PIX Key:
pix_key: The recipient's PIX key (can be an email, CPF, CNPJ, phone number, etc.).
pix_type: The type of the PIX key (e.g., "email", "cpf", "cnpj").
Additional Information:
description: An optional description of the transaction, which can be used to identify the payment.
reference: An optional reference for internal tracking of the transaction.
When the request is successful, the system returns a txid (transaction ID), which can be used to track and confirm the payment. The HTTP response code 201 indicates that the payment has been successfully initiated.
Example of Request
{
"bank_account_id": "0197676a-012d-725c-95fa-b9a54a4536b1",
"virtual_account_id": "0197676a-013e-7121-b1a5-e720b44c5c95",
"amount": 1000,
"currency": "BRL",
"pix_key": "[email protected]",
"pix_type": "email",
"description": "PIX payment",
"reference": "PIX-2025-001234"
}API Responses
201 Success: The payment has been successfully initiated and a txid will be returned for transaction identification.
403 Forbidden: Authentication or authorization error (check the API Key).
422 Validation: Validation failure for the provided data (check parameters, such as PIX key or transaction amount).
500 Internal Server Error: Internal server error.
Use Case
PIX Cashout is an excellent option for fast and secure payments, especially for payment platforms, e-commerce, or solutions that need an efficient way to transfer funds to users. The transaction is carried out instantly, without the need for intermediaries or waiting times typically associated with traditional methods like bank transfers.
Last updated