Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
composite
/
decode
Decodificar un QR compuesto de Pix Automático desde su URL
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recurrencePayloadUrl": "<string>"
}
'
import requests

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

payload = { "recurrencePayloadUrl": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({recurrencePayloadUrl: '<string>'})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/decode', 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/composite/decode",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recurrencePayloadUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"recurrencePayloadUrl\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/decode")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recurrencePayloadUrl\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recurrencePayloadUrl\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "contractNumber": "<string>",
  "debtor": {
    "cpfCnpj": "<string>",
    "name": "<string>",
    "personType": 123
  },
  "frequency": 123,
  "recipient": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "recurrenceId": "<string>",
  "retry": 123,
  "startDate": "<string>",
  "amount": 123,
  "contractDesc": "<string>",
  "createdDateTime": "<string>",
  "endDate": "<string>",
  "maxFloorAmount": 123,
  "presentedDateTime": "<string>",
  "updates": [
    {
      "status": 123,
      "statusDateTime": "<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).

Cuerpo

application/json
recurrencePayloadUrl
string
requerido

La URL del host JWS de la recurrencia que se va a decodificar (urlPayloadJsonRec; sin esquema).

Respuesta

OK

contractNumber
string
requerido

Identificador de contrato/orden (nrContrato).

debtor
object
requerido
frequency
integer<int64>
requerido

tpFrequencia.

recipient
object
requerido
recurrenceId
string
requerido

Id de recurrencia único.

retry
integer<int64>
requerido

Política de retentativa.

startDate
string
requerido

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

amount
number<double>

Monto fijo del pago en reales.

contractDesc
string

Descripción de contrato de texto libre.

createdDateTime
string

Marca de tiempo de creación del QR (dtHrCriacao).

endDate
string

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

maxFloorAmount
number<double>

Monto mínimo en reales (pisoValorMaximo).

presentedDateTime
string

Marca de tiempo de presentación del QR (dtHrApresentacao).

updates
object[] | null

Historial de estados de la recurrencia (atualizacoes).