Saltar al contenido principal
GET
/
v1
/
pix-automatico
/
schedules
/
{endToEndId}
Consultar la situación de una programación de Pix Automático
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/{endToEndId} \
  --header 'Authorization: Bearer <token>'
import requests

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

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/{endToEndId}', 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/{endToEndId}",
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/{endToEndId}"

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/{endToEndId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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

endToEndId
string
requerido

The payment-transaction id (32-char). El id de la transacción de pago (32 caracteres).

Respuesta

OK

debtor
object
requerido
endToEndId
string
requerido

El id de la transacción de pago (32 caracteres).

idRecorrencia
string
requerido

El id de recurrencia (RR...).

localStatus
string
requerido

ScheduleStatus local proyectado desde la situación del upstream.

localStatusKnown
boolean
requerido

False cuando la situación del upstream no lleva ningún estado local proyectado.

payer
object
requerido
recipient
object
requerido
scheduleStatus
integer<int64>
requerido

stAgendamento (0=Aceito, 1=Rejeitado; -1 cuando está ausente).

stJdPi
integer<int64>
requerido

Situación general del upstream (-1/0/9/10/11).

stJdPiProc
integer<int64>
requerido

Situación intermedia del upstream (0/1/2/5/7/8/9/10/11).

acceptRejectAt
string

Marca de tiempo de aceptación/rechazo (dtHrAceiteRejeite, UTC).

amount
number<double>

Monto programado en reales.

cancellations
object[] | null

Historial de cancelaciones (cancelamento).

dueDate
string

Fecha de vencimiento (aaaa-mm-dd).

errorCode
string

Código de error del upstream.

errorDesc
string

Descripción del error del upstream.

infoBetweenClients
string

Información del receptor al pagador de texto libre.

purpose
integer<int64>

finalidadeAgendamento.

recipientReceivedAt
string

Marca de tiempo de recepción del PSP beneficiario (UTC).

reconciliationId
string

El id de conciliación del receptor.

requestedAt
string

Marca de tiempo de la solicitud en el upstream (UTC).

situationAt
string

Marca de tiempo de la situación (dtHrSituacao, UTC).