Query Methods

Query Recurrence by Account

GetPixAutomatic: Queries all recurrences associated with a specific account.

{
    "Method": "GetPixAutomatic",
    "PartnerId": 30519,
    "BusinessUnitId": 51138,
    "TaxNumber": "12345678945",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
}

{
  "Success": "true",
  "Message": "Consulta realizada com sucesso.",
  "Recurrences": [
    {
      "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
      }
    }
  ]
}

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
Bank	Bank code of the user performing the action	Yes	String
BankBranch	Bank branch code of the user performing the action	Yes	String
BankAccount	Bank account number of the user performing the action	Yes	String
BankAccountDigit	Bank account digit of the user performing the action	Yes	String

Query Recurrence by ID

GetPixAutomaticById: Queries details of a specific recurrence.

{
    "Method": "GetPixAutomaticById",
    "PartnerId": "1234",
    "BusinessUnitId": "4321",
    "TaxNumber": "12345678945",
    "RecurrenceId": "RR2222222220240429njua7shf40k"
}

{
  "Success": "true",
  "Message": "Consulta realizada com sucesso.",
  "Recurrence": {
    "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
    }
  }
}

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

Query Schedules by Account

GetTransactionPixAutomatic: Queries all schedules associated with a specific account.

{
  "Method": "GetTransactionPixAutomatic",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "TaxNumber": "12345678900",
  "Bank": "450",
  "BankBranch": "0001",
  "BankAccount": "440246",
  "BankAccountDigit": "3"
}

{
  "Success": "true",
  "Schedules": [
    {
      "ScheduledId": "a650a666870647449f312628cd421938",
      "RecurrenceId": "RR13203354202511256785cecc367",
      "ReceiverName": "BU Pix",
      "ReceiverTaxNumber": "45748851000155",
      "PaymentDate": "27/11/2025",
      "Status": "Liquidado",
      "EndToEndId": "E1320335420251127030075125F59207"
    }
  ]
}

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
Bank	Bank code of the user performing the action	Yes	String
BankBranch	Bank branch code of the user performing the action	Yes	String
BankAccount	Bank account number of the user performing the action	Yes	String
BankAccountDigit	Bank account digit of the user performing the action	Yes	String

Query Schedule by ID

GetTransactionPixAutomaticById: Queries details of a specific schedule.

{
    "Method": "GetTransactionPixAutomaticById",
    "PartnerId": "1234",
    "BusinessUnitId": "4321",
    "TaxNumber": "12345678945",
    "RecurrenceId": "RR2222222220240429njua7shf40k",
    "ScheduledId": "122345"
}

{
  "Success": "true",
  "ScheduledId": "TX-987654321",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0",
  "Receiver": {
    "TaxNumber": "02332112232",
    "Name": "BU Pix"
  },
  "Debtor": {
    "TaxNumber": "***.834.718-**",
    "Name": "Taynara Diniz Moreira de Souza"
  },
  "Payer": {
    "TaxNumber": "***.834.718-**",
    "Name": "Taynara Diniz Moreira de Souza"
  },
  "Status": "Approved",
  "PaymentDate": "2025-08-25",
  "Value": 150
}

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
ScheduledId	Identifier for the scheduled transaction	No	String