Management

The APIs below can be used in both the payer's and the receiver's journey, according to the provided TaxNumber, contributing to more efficient management of cancellations, modifications, and queries.

1. Cancellation of Recurrence

Allows the payer to cancel a previously authorized recurrence.

{
    "Method": "CancelPixAutomatic",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "TaxNumber": "84928589076",
    "RecurrenceId": "12345678901234567890123456789"
}

{
    "Success": "true",
    "Message": "Cancellation completed successfully."
}

Parameter	Description	Mandatory	Type
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
TaxNumber	CPF/CNPJ of the user performing the action	Yes	String
RecurrenceId	Recurrence identifier	Yes	String

2. Cancellation of Schedule

Allows canceling a previously created Automatic Pix schedule.

{
    "Method": "CancelTransactionPixAutomatic",
    "BusinessUnitId": 1234,
    "PartnerId": 4321,
    "PayerIspb": 12345678,
    "ReceiverIspb": 87654321,
    "RecurrenceId": "RRR123456720240107000000002",
    "SchedulerId": "absdhidddFFG348764kbsjsQKIp",
    "TaxNumber": "12345678901"
}

{
    "Success": "true",
    "Message": "Cancellation completed successfully.",
    "RecurrenceId": "12345678901234567890123456789"
}

Note: The schedule can only be canceled until 11:59 PM on the day before the settlement date.

Parameter	Description	Mandatory	Type
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
PayerIspb	ISPB code of the payer's institution	Yes	Integer
ReceiverIspb	ISPB code of the receiver's institution	Yes	Integer
TaxNumber	CPF/CNPJ of the user performing the action	Yes	String
RecurrenceId	Recurrence identifier	Yes	String
SchedulerId	Identifier for the scheduled transaction	Yes	String

3. Modification of Recurrence

Allows modification of recurrence settings, such as notifications, credit line usage, or maximum value.

{
    "Method": "ChangePixAutomatic",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "TaxNumber": "32135498755",
    "RecurrenceId": "12345678901234567890123456789",
    "PayerName": null,
    "FirstPayment": null,
    "Notification": true,
    "CreditLine": true,
    "MaximumValue": 2000
}

{
    "Success": "true",
    "Message": "Recurrence modification completed 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
PayerName	Payer's name	No	String	For the receiver, at least one of the fields PayerName or FirstPayment must be filled.
FirstPayment	First payment	No	String	For the receiver, at least one of the fields PayerName or FirstPayment must be filled.
Notification	Indicates if scheduling notifications will be received	No	Boolean	For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled.
CreditLine	Indicates if payment is via credit line	No	Boolean	For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled.
MaximumValue	Maximum allowed value for the payment	No	Float	For the payer, at least one of the fields Notification, CreditLine, or MaximumValue must be filled.

4. Query Methods

The methods below allow querying information about recurrences and schedules.

4.1 Query Recurrence by Account

Queries all recurrences associated with a specific account.

{
    "Method": "GetPixAutomatic",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "TaxNumber": "12345678945",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
}

{
    "PixAutomatic": [
        {
            "RecurrenceId": "RR2222222220240429njua7shf40k",
            "ReceiverName": "Netflix",
            "ReceiverTaxNumber": "12.345.678/0001-00",
            "Status": "Pending"
        },
        {
            "RecurrenceId": "RR2222222220240429njua7shf40k",
            "ReceiverName": "Spotify",
            "ReceiverTaxNumber": "12.345.693/0001-00",
            "Status": "Settled"
        }
    ]
}

Parameter	Description	Mandatory	Type
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
Bank	Bank code of the user performing the action	Yes	String
BankBranch	Bank branch code of the user performing the action	Yes	String
BankAccount	Bank account number of the user performing the action	Yes	String
BankAccountDigit	Bank account digit of the user performing the action	Yes	String

4.2 Query Recurrence by ID

Queries details of a specific recurrence.

{
    "Method": "GetPixAutomaticById",
    "PartnerId": "1234",
    "BusinessUnitId": "4321",
    "TaxNumber": "12345678945",
    "RecurrenceId": "RR2222222220240429njua7shf40k"
}

{
    "RecurrenceId": "RR2222222220240429njua7shf40k",
    "Receiver": {
        "Name": "Netflix",
        "TaxNumber": "12.345.678/0001-00"
    },
    "Debtor": {
        "Name": "João Silva",
        "TaxNumber": "123.***.***-45"
    },
    "AuthorizationId": null,
    "Status": "Pending",
    "ContractId": "e791f33f-a8ca-4f30-8c29-ef8fdfe4f2e3",
    "Description": "Electricity bill",
    "InitialDate": "12/05/2025",
    "FinalDate": "12/05/2026",
    "Frequency": "Weekly",
    "OriginalValue": null,
    "MaximumValue": null,
    "Creditline": true,
    "Notification": true
}

Parameter	Description	Mandatory	Type
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

4.3 Query Schedules by Account

Queries all schedules associated with a specific account.

{
    "Method": "GetTransactionPixAutomatic",
    "PartnerId": "1234",
    "BusinessUnitId": "4321",
    "RecurrenceId": "RR2222222220240429njua7shf40k",
    "TaxNumber": "12345678945",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "33072795",
    "BankAccountDigit": "7"
}

[
    {
        "RecurrenceId": "RR2222222220240429njua7shf40k",
        "ScheduledId": "122344",
        "ReceiverName": "Spotify",
        "ReceiverTaxNumber": "12.345.693/0001-00",
        "PaymentDate": "2025-06-10T10:00:00Z",
        "Status": "Created"
    },
    {
        "RecurrenceId": "RR2222222220240429njua7shf40k",
        "ScheduledId": "122344",
        "ReceiverName": "Youtube",
        "ReceiverTaxNumber": "54.345.678/0001-00",
        "PaymentDate": "2025-06-11T10:00:00Z",
        "Status": "Canceled"
    }
]

Parameter	Description	Mandatory	Type
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
Bank	Bank code of the user performing the action	Yes	String
BankBranch	Bank branch code of the user performing the action	Yes	String
BankAccount	Bank account number of the user performing the action	Yes	String
BankAccountDigit	Bank account digit of the user performing the action	Yes	String

4.4 Query Schedule by ID

Queries details of a specific schedule.

{
    "Method": "GetTransactionPixAutomaticById",
    "PartnerId": "1234",
    "BusinessUnitId": "4321",
    "TaxNumber": "12345678945",
    "RecurrenceId": "RR2222222220240429njua7shf40k",
    "ScheduledId": "122345"
}

{
    "RecurrenceId": "RR2222222220240429njua7shf40k",
    "ScheduledId": "122345",
    "Receiver": {
        "Name": "Netflix",
        "TaxNumber": "12.345.678/0001-00"
    },
    "Debtor": {
        "Name": "João Silva",
        "TaxNumber": "123.***.***-45"
    },
    "AuthorizationId": null,
    "Status": "Created",
    "ContractId": "e791f33f-a8ca-4f30-8c29-ef8fdfe4f2e3",
    "Description": "Electricity bill",
    "PaymentDate": "12/05/2025",
    "Value": "50.00",
    "AdditionalInfo": null
}

Parameter	Description	Mandatory	Type
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
ScheduledId	Identifier for the scheduled transaction	No	String