📖Cash Out - Pix

In this article, we will thoroughly explore the journey of the Pix Cash Out API.

Introduction

The Pix Cash Out API enables instant transfers via Pix, facilitating payments from customer accounts. With robust and well-documented endpoints, this API offers essential functionalities for efficient and secure financial integrations. In this article, we will cover the prerequisites, explore the usage journey of this API, from balance inquiry to infraction defense, and highlight key use cases and Webhooks.

Prerequisites

1. Have credentials: client_id and client_secret, which are generated in Finance.
2. Obtain the certificate for the Cash In API.
3. Generate an access token to use the API's resources.
4. A transactionId is required for specific queries.

Important:

The certificate, credentials, and token for using the Cash Out Pix API are distinct from the Cash In Pix API.

Journey

1. Perform a Transaction

1.1. Initiate a Payment via QR Code

Initiates a payment using a QR Code.

• Use Case: This endpoint is used to generate a QR Code for Pix payment, ideal for use at points of sale or for in-person payments.

1.2. Initiate a Payment Using Banking Information

Performs a payment using banking information (account and branch number).

• Use Case: This endpoint is useful for direct transfers to bank accounts, such as paying suppliers or other B2B transactions.

1.3. Initiate a Payment via Pix Key

Performs a payment using a Pix key (CPF/CNPJ, phone number, email, etc.).

• Use Case: Ideal for quick and secure transfers using the recipient's Pix key.

2. Data Inquiry

2.1. Check Customer Account Balance

Queries the current balance of the customer's account.

• Use Case: This endpoint is used to check the available balance in the customer's account before initiating a Pix Cash Out operation.

2.2. List Customer Account Transactions

Lists transactions carried out in the customer's account.

• Use Case: Allows viewing the account's transaction history, useful for audits and financial reviews.

2.3. List Transaction Details

Lists specific details of a transaction using the transactionId.

• Use Case: This endpoint is used to obtain detailed information about a specific transaction, essential for dispute resolutions or detailed verifications.

2.4. Check Pix Operation Data by ID

Verifies the details of a specific Pix operation by endToEndId.

• Use Case: Allows tracking the status and details of a specific Pix operation, useful for monitoring individual transactions.

3. Infractions

3.1. Create a Defense Against an Infraction

Creates a defense against an open infraction.

• Use Case: Used to contest received infractions by providing justifications and evidence for analysis.

3.2. Check Open Infractions Against the Customer Account

Obtains a list of open infractions against the customer account.

• Use Case: Used to monitor infractions and take necessary actions for resolution.

3.3. Check Infraction Details by ID

Queries details about a specific infraction using the infractionId.

• Use Case: Allows checking detailed information about a specific infraction, useful for analysis and decision-making.

Webhooks

1. List Webhooks

Lists all webhooks configured in the system.

• Use Case: Allows verification of all registered webhooks, useful for managing and monitoring configured automatic notifications.

2. Query a Webhook

Queries the details of a specific webhook through a unique id.

• Use Case: Allows obtaining detailed information about a specific webhook, useful for checking its configurations and status.

3. Create Transfer Webhooks

Use this endpoint to create webhooks that will be triggered when the transfer operation is settled or canceled.

• Use Case: Allows setting up a webhook to be notified whenever a fund transfer is completed or canceled. This is useful for financial systems that need to monitor the completion of transfers, automate the accounting of received funds, update balances in real-time, and generate notifications for end-users regarding the status of transfers.

4. Create Withdrawal Operation Webhooks

Use this endpoint to create webhooks that will be triggered when the withdrawal operation is settled or canceled.

• Use Case: Allows setting up a webhook to be notified whenever a withdrawal operation is completed or canceled. This is useful for monitoring and managing account withdrawals, ensuring that withdrawal records are updated in financial systems, enabling automatic reconciliation of withdrawn amounts, and generating notifications for users about the status of their withdrawals.