Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Automatic Pix

GetTransactionPixAutomatic

Check the transaction schedules for an automatic Pix account.

post/GetTransactionPixAutomatic

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.

Bankstring required

Código do banco do pagador. Obrigatório. Erro: EXC0009 - É necessário informar a propriedade Bank.

BankBranchstring required

Agência do banco do pagador. Obrigatório. Erro: EXC0010 - É necessário informar a propriedadBankBranch.

BankAccountstring required

Conta do banco do pagador. Obrigatório. Erro: EXC0019 - É necessário informar a propriedadBankAccount.

BankAccountDigitstring required

Dígito da conta do pagador. Obrigatório. Erro: EXC0011 - É necessário informar a propriedadBankAccountDigit.

Example request

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

Response

Lista de transações encontrada

Success'true' | 'false'

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

Example response

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