v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

ChangePixAutomatic

Change the data of an automatic Pix recurrence.

post/ChangePixAutomatic

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.

TaxNumberstring required

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

RecurrenceIdstring required

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

CreditLineboolean

Indica se o pagador possui linha de crédito ativa para a recorrência. Obrigatório. Erro: EXC0004 - É necessário informar a propriedade CreditLine.

MaximumValuenumber

Valor máximo permitido para a recorrência.

Notificationboolean

Indica se o pagador deseja receber notificações. Obrigatório. Erro: EXC0003 - É necessário informar a propriedade Notification.

Example request

{
  "Method": "ChangePixAutomatic",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "TaxNumber": "12345678900",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0",
  "CreditLine": true,
  "MaximumValue": 1000,
  "Notification": true
}

Response

Recorrência Pix alterada 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 alterada.

Example response

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