Crear un código QR estático

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/brcode/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/brcode/static"

payload = {
    "receiverKey": "+5511999999999",
    "amount": "100.00",
    "description": "Payment for order"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    receiverKey: '+5511999999999',
    amount: '100.00',
    description: 'Payment for order'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/brcode/static', 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-indirect.api.lerian.net/v1/brcode/static",
  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([
    'receiverKey' => '+5511999999999',
    'amount' => '100.00',
    'description' => 'Payment for order'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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-indirect.api.lerian.net/v1/brcode/static"

	payload := strings.NewReader("{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/brcode/static")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/brcode/static")

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

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}"

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

{
  "id": "019c96a0-0bf7-7060-8f39-1bfbcb9168ca",
  "emv": "00020126580014br.gov.bcb.pix...",
  "base64": "<string>",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order #12345",
  "createdAt": "2024-01-15T10:30:00Z"
}

Crear un código QR estático

Usa este endpoint para crear un BR Code Pix estático que puede reutilizarse para múltiples pagos.

Notas:

Los códigos QR estáticos son reutilizables y se pueden pagar varias veces.
El monto es opcional: si no se proporciona, el pagador ingresará el monto.
La clave del receptor debe pertenecer al titular de la cuenta que realiza la solicitud.
El payload del código QR (EMV) se genera siguiendo la especificación EMV QCO.

POST

brcode

static

Crear un código QR estático

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/brcode/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order"
}
'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/brcode/static"

payload = {
    "receiverKey": "+5511999999999",
    "amount": "100.00",
    "description": "Payment for order"
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    receiverKey: '+5511999999999',
    amount: '100.00',
    description: 'Payment for order'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/brcode/static', 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-indirect.api.lerian.net/v1/brcode/static",
  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([
    'receiverKey' => '+5511999999999',
    'amount' => '100.00',
    'description' => 'Payment for order'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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-indirect.api.lerian.net/v1/brcode/static"

	payload := strings.NewReader("{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/brcode/static")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/brcode/static")

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

request = Net::HTTP::Post.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order\"\n}"

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

{
  "id": "019c96a0-0bf7-7060-8f39-1bfbcb9168ca",
  "emv": "00020126580014br.gov.bcb.pix...",
  "base64": "<string>",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order #12345",
  "createdAt": "2024-01-15T10:30:00Z"
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

X-Account-Id

string

requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de consulta

include_base64

boolean

predeterminado:false

Devuelve el código QR renderizado en base64 junto con el payload EMV.

Cuerpo

application/json

receiverKey

string

requerido

Clave Pix que recibirá el pago.

Ejemplo:

"+5511999999999"

amount

string

Monto fijo opcional.

Ejemplo:

"100.00"

description

string

Descripción personalizada.

Ejemplo:

"Payment for order #12345"

txId

string

Identificador de transacción opcional.

Ejemplo:

"TXabcdefghijklmno123456789"

Respuesta

Código QR estático creado correctamente.

string

Identificador único del código QR.

Ejemplo:

"019c96a0-0bf7-7060-8f39-1bfbcb9168ca"

emv

string

Payload EMV del código QR.

Ejemplo:

"00020126580014br.gov.bcb.pix..."

base64

string

Imagen del código QR codificada en base64 (si se solicita).

receiverKey

string

Clave Pix.

Ejemplo:

"+5511999999999"

amount

string

Monto fijo (si está definido).

Ejemplo:

"100.00"

description

string

Descripción.

Ejemplo:

"Payment for order #12345"

createdAt

string<date-time>

Ejemplo:

"2024-01-15T10:30:00Z"

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Crear un código QR estático

Autorizaciones

Encabezados

Parámetros de consulta

Cuerpo

Respuesta