Skip to main content
GET
/
v1
/
pix-automatico
/
authorizations
/
{idRecorrencia}
Consult a Pix Automático authorization situation
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"
}

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).

Path Parameters

idRecorrencia
string
required

The recurrence id (29-char, RR...).

Query Parameters

idReqJdPi
string

The upstream request id (GUID) fallback when the idRecorrencia consult 404s.

Response

OK

authorizationGiven
boolean
required

resultadoAutorizacao.

debtor
object
required
frequency
integer<int64>
required

tpFrequencia (0..4).

idRecorrencia
string
required

The recurrence id.

localStatus
string
required

Local AuthorizationStatus projected from the upstream situation.

localStatusKnown
boolean
required

False when the upstream situation carries no projected local status.

payer
object
required
recipient
object
required
stJdPi
integer<int64>
required

Upstream overall situation (-1/0/9/10).

stJdPiProc
integer<int64>
required

Upstream intermediate situation (0..10).

startDate
string
required

First payment date (aaaa-mm-dd).

amount
number<double>

Fixed payment amount in reais.

authorizedAt
string

Authorization timestamp (UTC).

cancellations
object[] | null

Cancellation history (cancelamentos).

contractDesc
string

Free-text contract description.

contractNumber
string

Contract/order identifier (nrContrato).

endDate
string

Last payment date (aaaa-mm-dd).

floorMaxAmount
number<double>

Receiver floor in reais.

idReqJdPi
string

The upstream request id (GUID).

idSolicitacao
string

The solicitation id (29-char, IS...).

journey
integer<int64>

jornada (1..4).

payerMaxAmount
number<double>

Payer max cap in reais.

requestedAt
string

Upstream request timestamp (UTC).

retry
integer<int64>

retentativa (0/1).

situationAt
string

Situation timestamp (dtHrSituacao, UTC).

updatedAt
string

Last-update timestamp (UTC).