Payouts

The Pix Payments API enables your client application to complete payouts in the most straightforward manner that exists in the Brazilian financial landscape. Using only a Pix key, Bitso disburses the funds to the recipient account. The API supports the four types of Pix keys consumers can use.

As in pay-ins, the API relies on its validation platform to ensure consumer screening, transaction limit validation, and third-party account verification before completing any payout.

The API includes the following set of RESTful endpoints for sending payments:

• Create a Pix payout: Within your website, consumers can request a withdrawal of funds anytime and seamlessly receive their money in the indicated account in a few seconds. Withdrawing funds is a two-step process: After requesting the transaction, the user gets a preview to verify the transaction details and then confirms the request.
• Retrieve a Pix payout: Get a previously enabled payment.
• Receive webhook notifications: Set up a callback URL where the webhook delivers automatic updates on your account's payout events.

Benefits

Enabling the Pix platform ensures Brazilian consumers have access to the most widely accepted method, guaranteeing seamless, 24/7 instant payments throughout the year.

On the other hand, the API strengthens your client application in diverse ways. Its validation platform ensures that the consumer clears the screening process before accepting any payout request and that the transaction occurs within the limits. These two validations may be optional depending on the type of business you intend to offer to your Brazilian customers and the entity under which you operate.

The platform also protects you from money laundering by ensuring that only your consumers can complete payments: Payouts to a third-party account are not allowed. The taxpayer ID who requests the payout is the only one who can receive the funds. This third-party account verification always occurs and cannot be turned off.

Use Case

Online betting websites enable consumers to wager money on a wide range of sporting events and games. These websites provide a platform that facilitates the betting process, from account creation to payouts.

Wagerers can request to withdraw their winnings from their betting accounts, and the website processes the transaction, transferring the funds via the wagerer's chosen payment method.

Figure 2 exemplifies how a Brazilian consumer's payout request can be fulfilled using the Pix Payments API:

The flow is the following:

1. A Brazilian wagerer (payee) requests to withdraw winnings from their online betting account and chooses Pix as the payment method.
2. The betting platform (payer) approves the submission and requests a Pix-based payout to the Pix Payments API, sending the wagerer's Pix key, and transaction's taxonomy, POST /v3/withdrawal/preview.
3. The service returns a preview of the transaction details for the user to verify and confirm.
4. If the user agrees, the betting platform sends a confirmation, POST /v3/withdrawals.
5. After confirmation, the service always performs the third-party account verification: The taxpayer ID registered in the withdrawal request must coincide with the ID registered in the account to which the funds are transferred. If false, the service rejects the payout. Otherwise, if the Bitso partner enables the screening and limits validation feature, the API screens the consumer using the taxpayer ID provided. If the consumer receives a thumbs up, then the API verifies their transaction limits.
6. If the consumer clears the validations, the API generates a Pix payout.
7. Bitso's Withdrawal Service deducts the funds to pay from the betting site's (merchant) account, disburses the funds to the wagerer's account, and notifies the merchant's callback URL of the payout.
8. The financial institution that manages the wagerer's account or wallet (recipient) credits the BRL funds received.