Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Automatic Pix

GetPixAutomatic

Check registered automatic Pix recurrences.

post/GetPixAutomatic

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 usuário que realiza a ação. Obrigatório. Erro: ISE0118 - É necessário informar o CPF/CNPJ.

Bankstring required

Código do banco do usuário que realiza a ação. Obrigatório. Erro: EXC0009 - É necessário informar a propriedade Bank.

BankBranchstring required

Agência do banco do usuário que realiza a ação. Obrigatório. Erro: EXC0010 - É necessário informar a propriedade BankBranch.

BankAccountstring required

Conta do banco do usuário que realiza a ação. Obrigatório. Erro: EXC0019 - É necessário informar a propriedade BankAccount.

BankAccountDigitstring required

Dígito da conta do usuário que realiza a ação. Obrigatório. Erro: EXC0011 - É necessário informar a propriedade BankAccountDigit.

Example request

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

Response

Lista de recorrências Pix encontrada

Success'true' | 'false'

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

Example response

{
  "Success": "true",
  "Recurrence": [
    {
      "RecurrenceId": "RN000011122233344455566677788",
      "ReceiverName": "Receiver - Pix Automático",
      "ReceiverTaxNumber": "00000000000191",
      "Status": "Ativa"
    }
  ]
}