Payer Journey

The payer journey allows a company or individual to set up automatic payments via Pix, defining recurrences, maximum values, credit lines, and notifications. Unlike other recurring payment methods, such as traditional direct debit, Automatic Pix offers greater control to the payer, who can manage authorizations directly through their financial institution’s app.

❗️
Regulatory Obligation

How It Works?

Pre-Authorization: The payer grants authorization for recurring payments to a receiver, establishing specific conditions for the transactions.
Automatic Execution: Payments are made automatically on the agreed dates, respecting the pre-authorized conditions.
Payer Control: The payer has the freedom to check, modify, or cancel the recurrence at any time, ensuring complete autonomy.
Security and Transparency: All transactions are processed 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 payers:

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

Journey	QR Code Reading	API Confirmation	Use of SearchProtocol	Notes
1	No	ConfirmPixAutomatic after webhook	No	Notifications managed by BU
2	GetInfosPixHashCode	ConfirmPixAutomatic	Yes, in the ConfirmPixAutomatic	QR with only recurrence data
3	GetInfosPixHashCode	GeneratePixOut	Yes, in the GeneratePixOut	QR with immediate payment and recurrence
4	GetInfosPixHashCode	ConfirmPixAutomatic after webhook	Yes, in the GeneratePixOut	QR code can be due date or static, both with recurrence data; notifications managed by BU

APIs Available for the Payer

The APIs below are exclusive to the payer journey.

Confirmation of Automatic Pix (Recurrence Authorization)

ConfirmPixAutomatic: Allows the payer to confirm the authorization of an automatic payment recurrence.

{
    "Method": "ConfirmPixAutomatic",
    "BusinessUnitId": "11427",
    "PartnerId": "564",
    "RecurrenceId": "RRR123456720240107000000001",
    "Description": "Monthly subscription charge for service X",
    "SearchProtocol": "336168424",
    "AuthorizationStatus": {
        "Status": "Approved",
        "ReasonCode": null
    },
    "Payer": {
        "TaxNumber": "12345678909",
        "Name": "João Silva",
        "Ispb": "13203354",
        "Bank": "450",
        "BankBranch": "3083",
        "BankAccount": "45843",
        "BankAccountDigit": "5",
        "ZipCode": "São Paulo"
    },
    "Payment": {
        "Notification": true,
        "Creditline": false,
        "MaximumValue": "150.00"
    }
}

{
    "Success": "true",
    "Message": "Automatic Pix recurrence confirmation registered successfully",
    "RecurrenceId": "12345678901234567890123456789"
}

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
Description	Description of the transaction or charge	Yes	String
SearchProtocol	Search or reference protocol	Conditional	String	Mandatory only for journey 2
AuthorizationStatus	Object containing authorization status information	Yes	Object
AuthorizationStatus.Status	Authorization status	Yes	String
AuthorizationStatus.ReasonCode	Reason code for rejection	Conditional	String	Mandatory only when the status is rejected
Payer	Object containing payer information	Yes	Object
Payer.TaxNumber	CPF/CNPJ of the payer	Yes	String
Payer.Name	Payer's name	Yes	String
Payer.Ispb	ISPB code of the payer's institution	Yes	String
Payer.Bank	Payer's bank code	Yes	String
Payer.BankBranch	Payer's bank branch code	Yes	String
Payer.BankAccount	Payer's bank account number	Yes	String
Payer.BankAccountDigit	Payer's bank account digit	Yes	String
Payer.ZipCode	Payer's postal code or city	Yes	String
Payment	Object containing payment information	Yes	Object
Payment.Notification	Indicates if scheduling notifications will be received	No	Boolean	Other notifications will be sent normally
Payment.Creditline	Indicates if payment is via credit line	No	Boolean
Payment.MaximumValue	Maximum allowed value for the payment	No	String

Read the QR Codes

GetInfosPixHashCode: Used for reading Composite QR Codes in Journeys 2, 3, and 4.

Generate first payment

GeneratePixOut: Allows the payer to make the first payment in journeys 3 and 4 and accept future recurrences in journey 3.

📘
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.

Payer Journey

❗️
Regulatory Obligation

How It Works?

Automatic Pix Journeys

APIs Available for the Payer

Confirmation of Automatic Pix (Recurrence Authorization)

Read the QR Codes

Generate first payment

📘
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.

❗️Regulatory Obligation

How It Works?

Automatic Pix Journeys

APIs Available for the Payer

Confirmation of Automatic Pix (Recurrence Authorization)

Read the QR Codes

Generate first payment

📘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.

❗️
Regulatory Obligation

📘
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.