Decodificar QR code

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qrCode": "00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081",
  "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'

import requests

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

payload = {
    "qrCode": "00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
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({
    qrCode: '00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081',
    accountId: '019c96a0-0a98-7287-9a31-786e0809c769'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/qrcodes/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/qrcodes/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([
    'qrCode' => '00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081',
    'accountId' => '019c96a0-0a98-7287-9a31-786e0809c769'
  ]),
  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"

	payload := strings.NewReader("{\n  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/qrcodes/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  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}"

response = http.request(request)
puts response.read_body

{
  "qrCodeType": "STATIC",
  "endToEndId": "E1234567820230615123456789012345",
  "amount": 100.5,
  "key": "+5511987654321",
  "description": "Payment for services",
  "txId": "tx_abc123",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  }
}

POST

qrcodes

decode

Decodificar QR code

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qrCode": "00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081",
  "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
'

import requests

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

payload = {
    "qrCode": "00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769"
}
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({
    qrCode: '00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081',
    accountId: '019c96a0-0a98-7287-9a31-786e0809c769'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/qrcodes/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/qrcodes/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([
    'qrCode' => '00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081',
    'accountId' => '019c96a0-0a98-7287-9a31-786e0809c769'
  ]),
  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"

	payload := strings.NewReader("{\n  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/qrcodes/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  \"qrCode\": \"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081\",\n  \"accountId\": \"019c96a0-0a98-7287-9a31-786e0809c769\"\n}"

response = http.request(request)
puts response.read_body

{
  "qrCodeType": "STATIC",
  "endToEndId": "E1234567820230615123456789012345",
  "amount": 100.5,
  "key": "+5511987654321",
  "description": "Payment for services",
  "txId": "tx_abc123",
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  }
}

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

Corpo

application/json

qrCode

string

obrigatório

String do QR code PIX a ser decodificada.

Exemplo:

"00020126580014br.gov.bcb.pix0136019c96a0-0c0c-7221-8cf3-13313fb60081"

accountId

string<uuid>

obrigatório

Identificador da conta solicitando a decodificacao.

Exemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

Resposta

QR code decodificado com sucesso

qrCodeType

enum<string>

obrigatório

Tipo de QR code PIX. Valores string indicando o comportamento e reutilizacao do QR code.

Valores validos:

STATIC = QR code reutilizavel com valor fixo (pode ser escaneado varias vezes)
DYNAMIC = QR code de uso unico (com tempo de expiracao e validacao avancada)

Opções disponíveis:

STATIC,

DYNAMIC

Exemplo:

"STATIC"

endToEndId

string

obrigatório

Identificador de transacao ponta a ponta.

Exemplo:

"E1234567820230615123456789012345"

amount

number<double>

obrigatório

Valor do pagamento.

Exemplo:

100.5

key

string

obrigatório

Chave PIX do destinatario.

Exemplo:

"+5511987654321"

description

string

obrigatório

Descricao do pagamento.

Exemplo:

"Payment for services"

txId

string

obrigatório

Identificador unico da transacao.

Exemplo:

"tx_abc123"

payee

object

obrigatório

Informacoes da conta bancaria.

Show child attributes

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado — Dataprev

Decodificar QR code

Autorizações

Corpo

Resposta