Skip to main content
POST
/
v1
/
qrcodes
/
decode
/
url
Decode a Pix QR code via its payload URL
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/decode/url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "payloadUrl": "<string>",
  "municipalityCode": "<string>",
  "paymentDate": "<string>"
}
'
import requests

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

payload = {
"accountId": "<string>",
"payloadUrl": "<string>",
"municipalityCode": "<string>",
"paymentDate": "<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({
accountId: '<string>',
payloadUrl: '<string>',
municipalityCode: '<string>',
paymentDate: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/qrcodes/decode/url', 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/qrcodes/decode/url",
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([
'accountId' => '<string>',
'payloadUrl' => '<string>',
'municipalityCode' => '<string>',
'paymentDate' => '<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/qrcodes/decode/url"

payload := strings.NewReader("{\n \"accountId\": \"<string>\",\n \"payloadUrl\": \"<string>\",\n \"municipalityCode\": \"<string>\",\n \"paymentDate\": \"<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/qrcodes/decode/url")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"<string>\",\n \"payloadUrl\": \"<string>\",\n \"municipalityCode\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"accountId\": \"<string>\",\n \"payloadUrl\": \"<string>\",\n \"municipalityCode\": \"<string>\",\n \"paymentDate\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "amount": 123,
  "payee": {
    "accountDigit": "<string>",
    "accountNumber": "<string>",
    "accountType": 123,
    "bankId": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "keyType": 123,
    "name": "<string>"
  },
  "qrCodeType": "<string>",
  "amountTroco": 123,
  "bankIdPss": 123,
  "description": "<string>",
  "dueDate": "<string>",
  "endToEndId": "<string>",
  "isPixSaque": true,
  "isPixTroco": true,
  "key": "<string>",
  "txId": "<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).

Body

application/json
accountId
string
required

The CRM account id of the scanning payer (sources the PI-PayerID document).

payloadUrl
string
required

The payee-published JWS payload URL to decode (urlPayloadJson; schema-less).

municipalityCode
string

Payer municipality code (codMun; cobv holiday calc).

paymentDate
string

Intended payment date (dPP; aaaa-mm-dd; cobv valorFinal calc).

Response

OK

amount
number<double>
required

The decoded amount in reais.

payee
object
required
qrCodeType
string
required

The decoded QR type (STATIC or DYNAMIC; cobv folds onto DYNAMIC).

amountTroco
number<double>

The Pix Troco amount in reais (troco only).

bankIdPss
integer<int64>

The saque/troco PSS participant ISPB.

description
string

Additional data (dadosAdicionais).

dueDate
string

Due date (cobv/static optional).

endToEndId
string

The SPI end-to-end id.

isPixSaque
boolean

Whether the QR carries a Pix Saque leg.

isPixTroco
boolean

Whether the QR carries a Pix Troco leg.

key
string

The recipient Pix key.

txId
string

Conciliation id (idConciliacaoRecebedor).