Create a Static QR Code

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 '
{
  "clientRequestId": "8c4ffd09-a264-4779-8d7e-fd24c971d7ff",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310000"
  },
  "tags": [
    "checkout",
    "web"
  ],
  "txId": "ORDER-12345"
}
'

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  \"clientRequestId\": \"8c4ffd09-a264-4779-8d7e-fd24c971d7ff\",\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order #12345\",\n  \"merchant\": {\n    \"categoryCode\": \"5411\",\n    \"city\": \"São Paulo\",\n    \"name\": \"Loja ABC\",\n    \"postalCode\": \"01310000\"\n  },\n  \"tags\": [\n    \"checkout\",\n    \"web\"\n  ],\n  \"txId\": \"ORDER-12345\"\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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    clientRequestId: '8c4ffd09-a264-4779-8d7e-fd24c971d7ff',
    receiverKey: '+5511999999999',
    amount: '100.00',
    description: 'Payment for order #12345',
    merchant: {
      categoryCode: '5411',
      city: 'São Paulo',
      name: 'Loja ABC',
      postalCode: '01310000'
    },
    tags: ['checkout', 'web'],
    txId: 'ORDER-12345'
  })
};

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

import requests

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

payload = {
    "clientRequestId": "8c4ffd09-a264-4779-8d7e-fd24c971d7ff",
    "receiverKey": "+5511999999999",
    "amount": "100.00",
    "description": "Payment for order #12345",
    "merchant": {
        "categoryCode": "5411",
        "city": "São Paulo",
        "name": "Loja ABC",
        "postalCode": "01310000"
    },
    "tags": ["checkout", "web"],
    "txId": "ORDER-12345"
}
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)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "emv": "000201010212...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310000"
  },
  "tags": [
    "checkout",
    "web"
  ],
  "txId": "ORDER-12345"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

brcode

static

Create a Static QR Code

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 '
{
  "clientRequestId": "8c4ffd09-a264-4779-8d7e-fd24c971d7ff",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310000"
  },
  "tags": [
    "checkout",
    "web"
  ],
  "txId": "ORDER-12345"
}
'

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  \"clientRequestId\": \"8c4ffd09-a264-4779-8d7e-fd24c971d7ff\",\n  \"receiverKey\": \"+5511999999999\",\n  \"amount\": \"100.00\",\n  \"description\": \"Payment for order #12345\",\n  \"merchant\": {\n    \"categoryCode\": \"5411\",\n    \"city\": \"São Paulo\",\n    \"name\": \"Loja ABC\",\n    \"postalCode\": \"01310000\"\n  },\n  \"tags\": [\n    \"checkout\",\n    \"web\"\n  ],\n  \"txId\": \"ORDER-12345\"\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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    clientRequestId: '8c4ffd09-a264-4779-8d7e-fd24c971d7ff',
    receiverKey: '+5511999999999',
    amount: '100.00',
    description: 'Payment for order #12345',
    merchant: {
      categoryCode: '5411',
      city: 'São Paulo',
      name: 'Loja ABC',
      postalCode: '01310000'
    },
    tags: ['checkout', 'web'],
    txId: 'ORDER-12345'
  })
};

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

import requests

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

payload = {
    "clientRequestId": "8c4ffd09-a264-4779-8d7e-fd24c971d7ff",
    "receiverKey": "+5511999999999",
    "amount": "100.00",
    "description": "Payment for order #12345",
    "merchant": {
        "categoryCode": "5411",
        "city": "São Paulo",
        "name": "Loja ABC",
        "postalCode": "01310000"
    },
    "tags": ["checkout", "web"],
    "txId": "ORDER-12345"
}
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)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "emv": "000201010212...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310000"
  },
  "tags": [
    "checkout",
    "web"
  ],
  "txId": "ORDER-12345"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Account ID (UUID format)

Query Parameters

include_base64

boolean

default:false

Returns the rendered QR code in base64 alongside the EMV payload

Body

application/json

clientRequestId

string

required

Idempotency token that will be echoed by BTG

Minimum string length: 1

Example:

"8c4ffd09-a264-4779-8d7e-fd24c971d7ff"

receiverKey

string

required

Pix key that will receive the payment

Minimum string length: 1

Example:

"+5511999999999"

amount

string

Fixed payment amount (optional, payer chooses if not provided)

Example:

"100.00"

description

string

Custom message or description shown to the payer

Example:

"Payment for order #12345"

merchant

object

Optional merchant metadata overrides

Show child attributes

Response

Created

createdAt

string

required

Timestamp when the BR Code was created

Example:

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

emv

string

required

QR code payload in EMV format

Example:

"000201010212..."

string

required

Unique identifier of the BR Code

Example:

"550e8400-e29b-41d4-a716-446655440010"

receiverKey

string

required

Pix key that will receive the payment

Example:

"+5511999999999"

amount

string

Fixed payment amount (optional)

Example:

"100.00"

base64

string

Base64-encoded QR code image (when requested)

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."

description

string

Custom message or description shown to the payer

Example:

"Payment for order #12345"

merchant

object

Merchant metadata for this BR Code

Show child attributes

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Create a Static QR Code

Authorizations

Headers

Query Parameters

Body

Response