Cancellation Methods

Cancellation of Recurrence

CancelPixAutomatic: 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

Cancellation of Schedule

CancelTransactionPixAutomatic: 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