Receiver Journey

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 (Receiver)

Similar to the payer journey, Automatic Pix offers different flows to meet the needs of receivers, providing flexibility in charge automation. Below, we detail the four journeys available for receivers:

Journey 1: Notification with Confirmation via Webhook

In this journey, the receiver requests that FitBank notify the payer about a pending recurrence response.

• How it works: The receiver creates the recurrence, and FitBank sends a notification to the payer.
• API Integration: GeneratePixAutomatic (to create the recurrence and initiate the notification process).

Journey 2: QR Code Scanning for Recurrence Authorization

The receiver creates a QR code containing only recurrence data, without immediate payment information. This QR code is provided to the payer to confirm the recurrence authorization.

• How it works: The receiver generates a QR code with recurrence data only, and the payer scans the QR code to retrieve the recurrence data and confirm the authorization.
• API Integration: GeneratePixQrCodeComposed (to generate the recurrence via QR code).

Journey 3: QR Code with Immediate Payment and Recurrence

The receiver creates a QR code containing both immediate payment data and recurrence data. By making the payment, the payer also automatically accepts the associated recurrence.

• How it works: The receiver generates a QR code with immediate payment and recurrence data, and the payer scans the QR code and makes the payment, with the recurrence acceptance processed automatically.
• API Integration: GenerateDynamicPixQRCode (to generate the recurrence and an immediate payment).

Journey 4: QR Code for Payment with Due Date and Recurrence Option

The receiver can create a QR code with a due date or a static QR code, both containing recurrence data. After the payment, the payer has the option to accept or reject the associated recurrence.

• How it works: The receiver can generate a QR code with a due date or a static QR code, both with recurrence data, and the payer scans the QR code and makes the payment. After the transaction, a recurrence offer is presented, which can be confirmed or rejected.
• API Integration: GeneratePixQrCodeDueDate (to generate the recurrence and a payment with a due date) or GenerateStaticPixQRCode (to generate the recurrence and a static payment).

APIs Available for the Receiver

The APIs below are exclusive to the receiver journey.

1. Generation of Automatic Pix (Journey 1)

GeneratePixAutomatic: Generates a notification directed to the payer to inform about Automatic Pix.

{
    "Method": "GeneratePixAutomatic",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "Retry": true,
    "Values": {
        "FinalValue": "100.00",
        "MaximumValue": "200.00"
    },
    "Receive": {
        "TaxNumber": "84.925.787/0001-76",
        "Name": "Empresa S.A",
        "ISPB": "84925787",
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "440246",
        "BankAccountDigit": "3"
    },
    "Payer": {
        "TaxNumber": "12345678900",
        "Name": "João da Silva",
        "ISPB": "12345678",
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "440246",
        "BankAccountDigit": "3"
    },
    "Contract": {
        "Identifier": "156184fsd4fsd48",
        "Description": "Gym membership installment"
    },
    "Date": {
        "Frequency": 0,
        "InitialDate": "2025-07-22",
        "EndDate": "2025-07-22"
    }
}

{
    "Success": "true",
    "Message": "Automatic Pix recurrence request sent successfully",
    "RecurrenceId": "12345678901234567890123456789"
}

2. Generation of Automatic Pix (Journey 2)

GeneratePixQrCodeComposed: Generates a QR code containing the recurrence data associated with Automatic Pix.

{
    "Method": "GeneratePixQrCodeComposed",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "Retry": true,
    "TxId": "233sdsffg34",
    "Values": {
        "FinalValue": "10.0",
        "MaximumValue": null
    },
    "Receive": {
        "TaxNumber": "84.925.787/0001-76",
        "Name": "Empresa S.A",
        "ISPB": null,
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "440246",
        "BankAccountDigit": "3"
    },
    "Contract": {
        "Identifier": "156184fsd4fsd48",
        "Description": "Gym membership installment",
        "Debtor": {
            "TaxNumber": "12345678900",
            "Name": "João da Silva"
        }
    },
    "Date": {
        "Frequency": 0,
        "InitialDate": "2025-06-26",
        "EndDate": "2025-06-26"
    }
}

{
    "Success": true,
    "Message": "Recurrence generated successfully",
    "TxId": "AAAAAaaaaa1111122222ZZZZZ33",
    "HashCode": "00020126180014br.gov.bcb.pix5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***80740014br.gov.bcb.pix2552pix.example.com/rec/2353c790eefb11eaadc10242ac1200026304F2DA"
}

3. Generation of Automatic Pix with Immediate First Payment (Journey 3)

GenerateDynamicPixQRCode: Generates a QR code for immediate payment. Only if recurrence data is provided, an Automatic PIX will be created with the first payment processed immediately.

4. Generation of Automatic Pix with Static First Payment (Journey 4)

GenerateStaticPixQRCode: Generates a static QR code. Only if recurrence data is provided, an Automatic PIX will be created with the first payment configured as static.

5. Generation of Automatic Pix with First Payment with Due Date (Journey 4)

GeneratePixQRCodeDueDate: Generates a QR code with a due date. Only if recurrence data is provided, an Automatic PIX will be created with the first payment subject to a due date.

Webhooks for the Receiver

🚧

Documentation under construction

📘

For better management of cancellation, change, and consult, we have shared APIs for payer and receiver, available here .