v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

ConfirmPixAutomatic

Confirm authorization of an automatic Pix recurrence.

post/ConfirmPixAutomatic

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 nullable

Identificador único da recorrência Pix. Máx. 29 caracteres. Erro: EXC0034 - O campo RecurrenceId não pode conter mais que 29 caracteres.

SearchProtocolinteger nullable

Protocolo de leitura do QRCode. Obrigatório para confirmação de uma recorrência oriunda da jornada 2.

Descriptionstring nullable

Descrição da recorrência Pix. Máx. 140 caracteres. Erro: EXC0035 - O campo Description não pode conter mais que 140 caracteres.

Example request

{
  "Method": "ConfirmPixAutomatic",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "RecurrenceId": "RN1320335420251010e50c9fe46b0",
  "SearchProtocol": 1234566,
  "Description": "Assinatura mensal de serviço X",
  "AuthorizationStatus": {
    "Status": "Approved",
    "ReasonCode": "SLBD"
  },
  "Payer": {
    "TaxNumber": "12345678909",
    "Name": "João da Silva",
    "Ispb": "12345678",
    "Bank": "001",
    "BankBranch": "1234",
    "BankAccount": "1234567",
    "BankAccountDigit": "9",
    "ZipCode": "12345678"
  },
  "Payment": {
    "CreditLine": true,
    "MaximumValue": 1000,
    "Notification": true
  }
}

Response

Confirmação realizada com sucesso

Success'true' | 'false' required

Indica se a operação foi realizada com sucesso ('true' ou 'false').

Messagestring required

Mensagem de retorno da operação.

RecurrenceIdstring nullable

Identificador da recorrência confirmada.

Example response

{
  "Success": "true",
  "Message": "Confirmação realizada com sucesso.",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0"
}