Pular para o conteúdo principal
GET
/
v1
/
pix-automatico
/
schedules
/
{endToEndId}
Consultar situação de agendamento 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"
}

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

endToEndId
string
obrigatório

O id da transação de pagamento (32 caracteres).

Resposta

OK

debtor
object
obrigatório
endToEndId
string
obrigatório

O id da transação de pagamento (32 caracteres).

idRecorrencia
string
obrigatório

O id da recorrência (RR...).

localStatus
string
obrigatório

ScheduleStatus local projetado a partir da situação do upstream.

localStatusKnown
boolean
obrigatório

False quando a situação do upstream não carrega status local projetado.

payer
object
obrigatório
recipient
object
obrigatório
scheduleStatus
integer<int64>
obrigatório

stAgendamento (0=Aceito, 1=Rejeitado; -1 quando ausente).

stJdPi
integer<int64>
obrigatório

Situação geral do upstream (-1/0/9/10/11).

stJdPiProc
integer<int64>
obrigatório

Situação intermediária do upstream (0/1/2/5/7/8/9/10/11).

acceptRejectAt
string

Data/hora de aceite/rejeição (dtHrAceiteRejeite, UTC).

amount
number<double>

Valor agendado em reais.

cancellations
object[] | null

Histórico de cancelamento (cancelamento).

dueDate
string

Data de vencimento (aaaa-mm-dd).

errorCode
string

Código de erro do upstream.

errorDesc
string

Descrição de erro do upstream.

infoBetweenClients
string

Informação em texto livre do recebedor para o pagador.

purpose
integer<int64>

finalidadeAgendamento.

recipientReceivedAt
string

Data/hora de recepção do PSP recebedor (UTC).

reconciliationId
string

O id de conciliação do recebedor.

requestedAt
string

Data/hora da requisição upstream (UTC).

situationAt
string

Data/hora da situação (dtHrSituacao, UTC).