List Pix Automático schedules

Lists live upstream scheduled payment instructions, scoped by flow + due-date window, projecting each onto the local schedule status. The response is an object wrapper carrying the upstream timestamp and the schedule snapshots.

GET /v1/pix-automatico/schedules/list

List Pix Automático schedules

cURL

curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list \
  --header 'Authorization: Bearer <token>'

200

{
  "jdPiAt": "<string>",
  "schedules": [
    {
      "debtor": {
        "cpfCnpj": "<string>",
        "name": "<string>",
        "personType": 123
      },
      "endToEndId": "<string>",
      "idRecorrencia": "<string>",
      "localStatus": "<string>",
      "localStatusKnown": true,
      "payer": {
        "account": "<string>",
        "accountType": 123,
        "agency": "<string>",
        "cnpj": "<string>",
        "cpfCnpj": "<string>",
        "ispb": "<string>",
        "name": "<string>",
        "personType": 123
      },
      "recipient": {
        "account": "<string>",
        "accountType": 123,
        "agency": "<string>",
        "cnpj": "<string>",
        "cpfCnpj": "<string>",
        "ispb": "<string>",
        "name": "<string>",
        "personType": 123
      },
      "scheduleStatus": 123,
      "stJdPi": 123,
      "stJdPiProc": 123,
      "acceptRejectAt": "<string>",
      "amount": 123,
      "cancellations": [
        {
          "cancelStatus": 123,
          "cancelledAt": "<string>",
          "idCancelamento": "<string>",
          "reason": 123,
          "recipientIspb": "<string>",
          "requesterDocument": "<string>",
          "requesterIspb": "<string>",
          "requesterType": 123,
          "errorCode": "<string>",
          "errorDesc": "<string>"
        }
      ],
      "dueDate": "<string>",
      "errorCode": "<string>",
      "errorDesc": "<string>",
      "infoBetweenClients": "<string>",
      "purpose": 123,
      "recipientReceivedAt": "<string>",
      "reconciliationId": "<string>",
      "requestedAt": "<string>",
      "situationAt": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

flow · integer<int64>

fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador).

recipientCnpj · string

cnpjRecebedor filter (string).

payerPersonType · string

tpPessoaPagador filter (0/1; empty = no filter).

payerDocument · string

cpfCnpjPagador filter (string).

payerAgency · string

nrAgenciaPagador filter (string).

payerAccount · string

nrContaPagador filter (string).

scheduleStatus · string

stAgendamento filter (0/1; empty = no filter).

dueDateFrom · string

dtVencimentoInicio (aaaa-mm-dd).

dueDateTo · string

dtVencimentoFim (aaaa-mm-dd).

page · integer<int64>

pagina (default 1).

pageSize · integer<int64>

tamanhoPagina (default 50, max 100).

Response

200

application/json

OK

jdPiAt · string · required

Upstream response timestamp (upstream timestamp, UTC).

schedules · object[] | null · required

The matching schedule snapshots (agendamentos).

Show child attributes