Pix Cash-Out Send
A 3-step recipe with Efí Pay (Gerencianet). We can help you get access.
Recipe · 3 steps
Pix Cash-Out Send
with Efí Pay (Gerencianet) · Real-Time Payment Management
Submit an outbound Pix payout and confirm its settlement status.
- Exchange the client_id and client_secret for an OAuth2 access token using the client_credentials grant required by the Pix API.
- Submit the outbound Pix payout from the account's Pix key to the destination Pix key under the supplied idEnvio.
- Read the outbound Pix back by idEnvio and branch on its status to confirm whether the payout has been settled (REALIZADO).
What you'll need to have ready
- clientId: The OAuth2 client_id issued for the Efí Pay account.
- clientSecret: The OAuth2 client_secret issued for the Efí Pay account.
- idEnvio: A caller-generated idempotency id for the outbound Pix send.
- amount: The payout amount in BRL as a decimal string.
- payerPixKey: The account's own Pix key debited for the payout (pagador.chave).
- destinationPixKey: The destination Pix key credited by the payout (favorecido.chave).
For your developer
Arazzo workflow gerencianet:pix-send-cashout, 3 operations: contasAuthorize → pixSend → pixSendDetailId. Specs on APIs.io.