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

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

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

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

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

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
{
  "authorizationGiven": true,
  "debtor": {
    "cpfCnpj": "<string>",
    "name": "<string>",
    "personType": 123
  },
  "frequency": 123,
  "idRecorrencia": "<string>",
  "localStatus": "<string>",
  "localStatusKnown": true,
  "payer": {
    "account": "<string>",
    "accountType": 123,
    "agency": "<string>",
    "cpfCnpj": "<string>",
    "ibgeCode": 123,
    "ispb": "<string>",
    "name": "<string>",
    "personType": 123
  },
  "recipient": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "stJdPi": 123,
  "stJdPiProc": 123,
  "startDate": "<string>",
  "amount": 123,
  "authorizedAt": "<string>",
  "cancellations": [
    {
      "cancelStatus": 123,
      "cancelledAt": "<string>",
      "idCancelamento": "<string>",
      "reason": 123,
      "requesterDocument": "<string>",
      "requesterType": 123,
      "errorCode": "<string>",
      "errorDesc": "<string>"
    }
  ],
  "contractDesc": "<string>",
  "contractNumber": "<string>",
  "endDate": "<string>",
  "floorMaxAmount": 123,
  "idReqJdPi": "<string>",
  "idSolicitacao": "<string>",
  "journey": 123,
  "payerMaxAmount": 123,
  "requestedAt": "<string>",
  "retry": 123,
  "situationAt": "<string>",
  "updatedAt": "<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

idRecorrencia
string
requerido

The recurrence id (29-char, RR...). El id de recurrencia (29 caracteres, RR...).

Parámetros de consulta

idReqJdPi
string

The upstream request id (GUID) fallback when the idRecorrencia consult 404s. El id de solicitud del upstream (GUID) de reserva cuando la consulta por idRecorrencia devuelve 404.

Respuesta

OK

authorizationGiven
boolean
requerido

resultadoAutorizacao.

debtor
object
requerido
frequency
integer<int64>
requerido

tpFrequencia (0..4).

idRecorrencia
string
requerido

El id de recurrencia.

localStatus
string
requerido

AuthorizationStatus 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
stJdPi
integer<int64>
requerido

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

stJdPiProc
integer<int64>
requerido

Situación intermedia del upstream (0..10).

startDate
string
requerido

Fecha del primer pago (aaaa-mm-dd).

amount
number<double>

Monto fijo del pago en reales.

authorizedAt
string

Marca de tiempo de la autorización (UTC).

cancellations
object[] | null

Historial de cancelaciones (cancelamentos).

contractDesc
string

Descripción de contrato de texto libre.

contractNumber
string

Identificador de contrato/orden (nrContrato).

endDate
string

Fecha del último pago (aaaa-mm-dd).

floorMaxAmount
number<double>

Monto mínimo del receptor en reales.

idReqJdPi
string

El id de solicitud del upstream (GUID).

idSolicitacao
string

El id de solicitud (29 caracteres, IS...).

journey
integer<int64>

jornada (1..4).

payerMaxAmount
number<double>

Tope máximo del pagador en reales.

requestedAt
string

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

retry
integer<int64>

retentativa (0/1).

situationAt
string

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

updatedAt
string

Marca de tiempo de la última actualización (UTC).