v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payment and Payment Management

CancelPixRecurrence

This method can be used to cancel a recurring Pix schedule (fully or partially).

post/CancelPixRecurrence

Request body

Methodstring required

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

TaxNumberstring required

CPF/CNPJ of the holder of the recurrence.

Identifierstring required

Unique recurrence identifier.

CancelAllRecurrenceboolean required

Defines whether to cancel the entire recurrence (true) or only specific items (false).

TransactionsRecurrencestring[]

List of identifiers of recurring transactions to cancel (required if CancelAllRecurrence is false).

Example request

{
  "Method": "CancelPixRecurrence",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "TaxNumber": "12345678900",
  "Identifier": "recorrencia-aluguel-2025",
  "CancelAllRecurrence": true,
  "TransactionsRecurrence": [
    "trans_01",
    "trans_02"
  ]
}

Response

Cancellation successful

Successstring

Messagestring

Example response

{
  "Success": "true",
  "Message": "ISI0001 - Método executado com sucesso"
}