📖Cash in - Pix

In this article, we will delve into the comprehensive journey of the Pix Cash In API.

Introduction

The Pix Cash In API allows for the creation and management of instant and due date payments. 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 payment creation to transaction query, 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 txid (Transaction Identifier) is required.

Important:

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

Journey

1. Immediate Payment Creation

Creates an immediate payment with a specific txid.

• Use Case: This endpoint is used to generate a Pix payment that must be paid instantly. For example, in an e-commerce setting, an immediate payment can be created and sent to the customer for payment upon checkout.

2. Review Immediate Payment

Reviews an existing immediate payment, incrementing the revision by 1.

• Use Case: This endpoint is used to update details of an already existing payment, such as the amount or due date, if adjustments are needed after the initial creation.

3. Immediate Payment Query

Queries the details of an immediate payment through a specific txid.

• Use Case: Allows verification of the status and details of a generated payment, useful for customer support systems that need to confirm the receipt of payments.

4. Due Date Payment Creation

Creates a due date payment associated with a txid.

• Use Case: Used to generate payments that have a future due date, such as school fees or subscription services.

5. Due Date Payment Query

Queries the details of a due date payment through a specific txid.

• Use Case: Allows verification of the status and details of a due date payment, useful for monitoring recurring payments.

6. Pix Query

Queries the details of a specific Pix transaction through an e2eid.

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

7. Query Received Pix

Queries all Pix transactions received within a specified period.

• Use Case: Allows listing and tracking all Pix transactions received within a specified period, useful for financial control and accounting.

8. Request Refund

Requests a refund of a received Pix through an e2eid and id.

• Use Case: Allows initiating the refund process for a value received via Pix, useful for resolving payment errors or handling refund requests.

9. Refund Query

Queries the status of a requested refund through an e2eid and id.

• Use Case: Allows verification of the status and details of a requested refund, useful for tracking the refund process and ensuring it has been completed.

---

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 Webhooks to Receive Operations (Cash In)

Creates a webhook to receive notifications of cash in (received payments) operations.

• Use Case: Allows setting up a webhook to be notified whenever a new payment is received, useful for integration with financial systems and automating incoming cash processes.

4. Create Webhooks for Refund Operations

Creates a webhook to receive notifications of refund operations.

• Use Case: Allows setting up a webhook to be notified whenever a refund is processed, useful for monitoring and managing payment refunds.