Pular para o conteúdo principal
GET
/
v1
/
pix-automatico
/
authorizations
Listar autorizações de Pix Automático
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations \
  --header 'Authorization: Bearer <token>'
import requests

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

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', 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",
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"

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

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

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
{
  "authorizations": [
    {
      "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>"
    }
  ],
  "jdPiAt": "<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 consulta

flow
integer<int64>

fluxo (0=PSP Pagador, 1=PSP Recebedor).

recipientCnpj
string

Filtro cnpjRecebedor (string).

payerPersonType
string

filtro tpPessoaPagador (0/1; vazio = sem filtro).

payerDocument
string

Filtro cpfCnpjPagador (string).

payerAgency
string

nrAgenciaPagador filtro (string).

payerAccount
string

nrContaPagador filtro (string).

authorizationOk
string

filtro resultadoAutorizacao (true/false; vazio = sem filtro).

stJdPiProc
string

Filtro de status de processo do upstream (0..10; vazio = sem filtro).

updatedFrom
string

dtHrAtualizacaoRecorrenciaInicio (UTC).

updatedTo
string

dtHrAtualizacaoRecorrenciaFim (UTC).

page
integer<int64>

pagina (padrão 1).

pageSize
integer<int64>

tamanhoPagina (padrão 50, máx. 100).

Resposta

OK

authorizations
object[] | null
obrigatório

Os snapshots de autorização correspondentes.

jdPiAt
string
obrigatório

Data/hora da resposta do upstream (upstream timestamp, UTC).