Saltar al contenido principal
GET
/
v1
/
pix-automatico
/
schedules
/
list
Listar programaciones de Pix Automático
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>"
    }
  ]
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de consulta

flow
integer<int64>

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

recipientCnpj
string

cnpjRecebedor filter (string). Filtro cnpjRecebedor (cadena).

payerPersonType
string

tpPessoaPagador filter (0/1; empty = no filter). Filtro tpPessoaPagador (0/1; vacío = sin filtro).

payerDocument
string

cpfCnpjPagador filter (string). Filtro cpfCnpjPagador (cadena).

payerAgency
string

nrAgenciaPagador filter (string). Filtro nrAgenciaPagador (cadena).

payerAccount
string

nrContaPagador filter (string). Filtro nrContaPagador (cadena).

scheduleStatus
string

stAgendamento filter (0/1; empty = no filter). Filtro stAgendamento (0/1; vacío = sin filtro).

dueDateFrom
string

dtVencimentoInicio (aaaa-mm-dd).

dueDateTo
string

dtVencimentoFim (aaaa-mm-dd).

page
integer<int64>

pagina (default 1). pagina (por defecto 1).

pageSize
integer<int64>

tamanhoPagina (default 50, max 100). tamanhoPagina (por defecto 50, máx. 100).

Respuesta

OK

jdPiAt
string
requerido

Marca de tiempo de la respuesta del upstream (marca de tiempo del upstream, UTC).

schedules
object[] | null
requerido

Las instantáneas de programación coincidentes (agendamentos).