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

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

idRecorrencia
string
obrigatório

O id da recorrência (29 caracteres, RR...).

Parâmetros de consulta

idReqJdPi
string

O id da requisição upstream (GUID) fallback quando a consulta por idRecorrencia dá 404.

Resposta

OK

authorizationGiven
boolean
obrigatório

resultadoAutorizacao.

debtor
object
obrigatório
frequency
integer<int64>
obrigatório

tpFrequencia (0..4).

idRecorrencia
string
obrigatório

O id da recorrência.

localStatus
string
obrigatório

AuthorizationStatus 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
stJdPi
integer<int64>
obrigatório

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

stJdPiProc
integer<int64>
obrigatório

Situação intermediária do upstream (0..10).

startDate
string
obrigatório

Data do primeiro pagamento (aaaa-mm-dd).

amount
number<double>

Valor fixo de pagamento em reais.

authorizedAt
string

Data/hora da autorização (UTC).

cancellations
object[] | null

Histórico de cancelamentos (cancelamentos).

contractDesc
string

Descrição de contrato em texto livre.

contractNumber
string

Identificador de contrato/pedido (nrContrato).

endDate
string

Data do último pagamento (aaaa-mm-dd).

floorMaxAmount
number<double>

Piso do recebedor em reais.

idReqJdPi
string

O id da requisição upstream (GUID).

idSolicitacao
string

O id da solicitação (29 caracteres, IS...).

journey
integer<int64>

jornada (1..4).

payerMaxAmount
number<double>

Teto máximo do pagador em reais.

requestedAt
string

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

retry
integer<int64>

retentativa (0/1).

situationAt
string

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

updatedAt
string

Data/hora da última atualização (UTC).