Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Automatic Pix

GetTransactionPixAutomaticById

Check the transactions of an automatic Pix recurrence by identifier.

post/GetTransactionPixAutomaticById

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 da Transação.

ScheduledIdstring required

Identificador da transação. Obrigatório. Máx. 40 caracteres.

RecurrenceIdstring required

Identificador da recorrência alterada.

Example request

{
  "Method": "GetTransactionPixAutomaticById",
  "PartnerId": 1001,
  "BusinessUnitId": 2002,
  "ScheduledId": "TX-987654321",
  "RecurrenceId": "RN1320335420251010e50c9fe46b0"
}

Response

Transação encontrada

Success'true' | 'false'

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

ScheduledIdstring

Identificador da transação.

RecurrenceIdstring

Identificador da recorrência relacionada.

Status'Approved' | 'PreApproved' | 'Rejected' | 'PreRejected' | 'Pending' | 'Expired' | 'Processing' | 'Canceled' | 'Canceling'

Status da transação.

PaymentDatestring date

Data de pagamento da transação.

Valuenumber

Valor da transação.

Example response

{
  "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
}