v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Automatic Pix

GetPixAutomaticById

Check an automatic Pix recurrence by identifier.

post/GetPixAutomaticById

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.

RecurrenceIdstring required

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

Example request

{
  "Method": "GetPixAutomaticById",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "TaxNumber": "12345678900",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0"
}

Response

Recorrência Pix encontrada

Success'true' | 'false'

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

Messagestring

Mensagem de retorno da operação.

Example response

{
  "Success": "true",
  "Message": "Consulta realizada com sucesso.",
  "Recurrence": {
    "RecurrenceId": "RN000011122233344455566677788",
    "Receiver": {
      "TaxNumber": "00000000000191",
      "Name": "Receiver - Pix Automático"
    },
    "Debtor": {
      "TaxNumber": "00000000000191",
      "Name": "Debtor - Pix Automático"
    },
    "Payer": {
      "TaxNumber": "00000000000191",
      "Name": "Debtor - Pix Automático"
    },
    "AuthorizationId": "11ce42cb-0000-0000-0000-136c92d967ff",
    "Status": "Ativa",
    "ContractId": "11ce42cb-0000-1111-0000-136c92d967ff",
    "Description": "Descrição do contrato.",
    "InitialDate": "2023-01-01",
    "FinalDate": "2023-12-31",
    "Frequency": "Mensal",
    "OriginalValue": 10,
    "Creditline": true,
    "Notification": true
  }
}