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), NotifySuccess (endpoint when the recurrence is approved) or NotifyFailure (endpoint when the recurrence is rejected).

More details:

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

NotifySucess: This webhook notifies that the recurrence has been approved.

NotifyFailure: This webhook notifies that the recurrence has been rejected.

GeneratePixQrCodeComposed

{
    "Method": "GeneratePixQrCodeComposed",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73",
    "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"
}

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
Identifier	Unique Internal Identifier of the Recurrence	Yes	String
Retry	Indicates if the recurrence can have retries	Yes	Boolean
TxId	Transaction identifier	Yes	String
Values	Object containing value-related information	Yes	Object
Values.FinalValue	Transaction value	Conditional	String	Must be filled in case of a fixed value
Values.MaximumValue	Maximum allowed value for the transaction	Conditional	String	Must be filled in case of a variable value
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
Contract	Object containing contract information	Yes	Object
Contract.Identifier	Contract identifier	Yes	String
Contract.Description	Contract or transaction description	Yes	String
Contract.Debtor	Object containing debtor information	Yes	Object
Contract.Debtor.TaxNumber	CPF/CNPJ of the debtor	Yes	String
Contract.Debtor.Name	Debtor's name	Yes	String
Date	Object containing date-related information	Yes	Object
Date.Frequency	Transaction frequency	Yes	Integer	WEEKLY = 0, MONTHLY = 1, QUARTERLY = 2, SEMIANNUAL = 3, ANNUAL = 4
Date.InitialDate	Transaction start date	Yes	String
Date.EndDate	Transaction end date	Yes	String

Updated about 5 hours ago