Receiver Journey

🚧
These APIs are still in development and are not yet ready for integration or testing.

The receiver journey enables businesses to set up automatic collections via Pix, generating notifications or QR codes and managing recurrences. This functionality is ideal for businesses seeking to simplify their clients’ payment methods, optimizing the management of recurring charges in a secure and efficient manner.

How It Works?

Recurrence Creation: The receiver creates recurrences to organize and facilitate the management of periodic charges.
Charge Scheduling: The receiver configures schedules according to established periodicity rules, ensuring predictability in collections.
Management and Control: The receiver has the flexibility to modify, cancel, or query recurrences and transactions at any time, maintaining full control over the process.
Security and Transparency: All transactions are conducted in the secure Pix environment, ensuring traceability and data protection.

Automatic Pix Journeys

Automatic Pix offers different flows to meet the needs of end users and business units, ensuring flexibility in payment automation. Below, we detail the four journeys available for payees:

Journey 1:Notification with Confirmation via Webhook
Journey 2: QR Code Scanning for Recurrence Authorization
Journey 3: QR Code with Immediate Payment and Recurrence
Journey 4: QR Code for Payment with Due Date and Recurrence Option

Automatic Pix Scheduling

The receiver requests a scheduling using the recurrence identifier.

How it works: The receiver must schedule a Pix transaction 2 to 10 days in advance, ensuring the scheduling data matches the previously created recurrence. If the scheduling is not done, the payment will not be processed.
API Integration: GenerateTransactionPixAutomatic (to schedule and automate recurring Pix transactions) and NotifySchedule (when the transaction is scheduled by the Payer's Institution).

Automatic Pix Scheduling

Creates a scheduling request, regardless of the chosen journey. The receiver must submit the scheduling instruction for the charge to be processed.

{
  "Method": "GenerateTransactionPixAutomatic",
  "BusinessUnitId": 51138,
  "PartnerId": 30519,
  "RecurrenceId": "12345678901234567890123456789",
  "Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73",
  "NewAttempt": true,
  "Receiver": {
    "TaxNumber": "84928589076",
    "Name": "user",
    "ISPB": null,
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
  },
  "Payer": {
    "TaxNumber": "12345678900",
    "Name": "João da Silva",
  },
  "Value": "10.00",
  "Rate": "0.05",
  "ChargeDate": "2025-06-26",
  "Description": "Pix recurring payment"
}

{
  "Success": "true",
  "Message": "Solicitação de realizado com sucesso"
}

Parameter	Description	Mandatory	Type	Comments
Method	Method or action to be executed in the request	Yes	String
BusinessUnitId	Identifier of the business unit	Yes	Integer
PartnerId	Partner identifier	Yes	Integer
RecurrenceId	Recurrence identifier	Yes	String	Must match the previously created recurrence
Identifier	Unique Internal Identifier of the Recurrence	Yes	String
NewAttempt	Indicates if it is a new attempt	Yes	Boolean	The created recurrence must be configured to allow new attempts.
Receive	Object containing receiver information	Yes	Object
Receive.TaxNumber	CNPJ of the receiver	Yes	String
Receive.Name	Receiver's name	Yes	String
Receive.ISPB	ISPB code of the receiver's institution	Yes	String
Receive.Bank	Receiver's bank code	Yes	String
Receive.BankBranch	Receiver's bank branch code	Yes	String
Receive.BankAccount	Receiver's bank account number	Yes	String
Receive.BankAccountDigit	Receiver's bank account digit	Yes	String
Payer	Object containing payer information	Yes	Object
Payer.TaxNumber	CPF/CNPJ of the payer	Yes	String
Payer.Name	Payer's name	Yes	String
Value	Transaction value	Yes	String	Must adhere to the fixed value or maximum limit defined in the previously created recurrence
Rate	Scheduling Fee Value	Yes	String
ChargeDate	Charge date	Yes	String	Must be submitted 2 to 10 days in advance
Description	Transaction description	Yes	String

📘
To better manage cancellations, changes, and queries, we share APIs for payers and receiver, available here .

📘
To receive webhooks, we share payloads for payers and receiver, available here.

Receiver Journey

🚧
These APIs are still in development and are not yet ready for integration or testing.

How It Works?

Automatic Pix Journeys

Automatic Pix Scheduling

Automatic Pix Scheduling

📘
To better manage cancellations, changes, and queries, we share APIs for payers and receiver, available here .

📘
To receive webhooks, we share payloads for payers and receiver, available here.

🚧These APIs are still in development and are not yet ready for integration or testing.

How It Works?

Automatic Pix Journeys

Automatic Pix Scheduling

Automatic Pix Scheduling

📘To better manage cancellations, changes, and queries, we share APIs for payers and receiver, available here .

📘To receive webhooks, we share payloads for payers and receiver, available here.

🚧
These APIs are still in development and are not yet ready for integration or testing.

📘
To better manage cancellations, changes, and queries, we share APIs for payers and receiver, available here .

📘
To receive webhooks, we share payloads for payers and receiver, available here.