v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

CancelPixAutomatic

This method can be used to cancel a scheduled Pix automatic transaction.

post/CancelPixAutomatic

Request body

Methodstring required

Nome do método a ser executado. Obrigatório. Erro: ISE0056 - Method não informado.

PartnerIdinteger required

Identificador do parceiro integrador. Obrigatório. Erro: ISE0057 - PartnerId não informado.

BusinessUnitIdinteger required

Identificador da unidade de negócio. Obrigatório. Erro: ISE0058 - BusinessUnitId não informado.

RecurrenceIdstring required

Identificador da recorrência a ser cancelada. Obrigatório. Máx. 29 caracteres. Erro: EXC0034 - O campo RecurrenceId não pode conter mais que 29 caracteres.

TaxNumberstring required

CPF/CNPJ do pagador. Obrigatório. Erro: ISE0118 - É necessário informar o CPF/CNPJ.

Example request

{
  "Method": "CancelPixAutomatic",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "RecurrenceId": "RN1320335420251010e50c9fe46b0",
  "TaxNumber": "12345678900"
}

Response

Recorrência Pix cancelada com sucesso

Success'true' | 'false' required

Indica se a operação foi realizada com sucesso.

Messagestring required

Mensagem de retorno da operação.

RecurrenceIdstring nullable required

Identificador da recorrência cancelada.

Example response

{
  "Success": "true",
  "Message": "Recorrência Pix cancelada com sucesso.",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0"
}