Get a static BR Code by ID

curl --request GET \
  --url https://api.example.com/cob-hub/v1/brcodes/static/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/cob-hub/v1/brcodes/static/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/cob-hub/v1/brcodes/static/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2026-05-06T10:30:00Z",
  "emvPayload": "00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja Teste6007Goiania62110507TX123456304AA54",
  "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
  "keyType": "CPF",
  "keyValue": "39053344705",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
  "status": "ACTIVE",
  "type": "STATIC",
  "updatedAt": "2026-05-06T10:30:00Z",
  "amount": "100.50",
  "currency": "BRL",
  "description": "Pagamento do pedido 12345"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0015",
  "title": "Bad Request",
  "status": 400,
  "detail": "One or more path parameters are invalid.",
  "code": "PIX-0015"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0205",
  "title": "Not Found",
  "status": 404,
  "detail": "BR Code does not exist for this organization.",
  "code": "PIX-0205"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server encountered an unexpected error. Please try again later.",
  "code": "PIX-0000"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

brcodes

static

{id}

Get a static BR Code by ID

curl --request GET \
  --url https://api.example.com/cob-hub/v1/brcodes/static/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/cob-hub/v1/brcodes/static/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/cob-hub/v1/brcodes/static/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2026-05-06T10:30:00Z",
  "emvPayload": "00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja Teste6007Goiania62110507TX123456304AA54",
  "id": "0196a7b2-1c3d-7e4f-8a90-1234567890ab",
  "keyType": "CPF",
  "keyValue": "39053344705",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "organizationId": "0196a7b2-2d4e-7f50-9b01-234567890abc",
  "status": "ACTIVE",
  "type": "STATIC",
  "updatedAt": "2026-05-06T10:30:00Z",
  "amount": "100.50",
  "currency": "BRL",
  "description": "Pagamento do pedido 12345"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0015",
  "title": "Bad Request",
  "status": 400,
  "detail": "One or more path parameters are invalid.",
  "code": "PIX-0015"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0205",
  "title": "Not Found",
  "status": 404,
  "detail": "BR Code does not exist for this organization.",
  "code": "PIX-0205"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server encountered an unexpected error. Please try again later.",
  "code": "PIX-0000"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

BR Code UUID

Ejemplo:

"019e22f9-aabe-7ec9-ba6b-41608b9accf9"

Respuesta

createdAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

emvPayload

string

requerido

Ejemplo:

"00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja Teste6007Goiania62110507TX123456304AA54"

string

requerido

Ejemplo:

"0196a7b2-1c3d-7e4f-8a90-1234567890ab"

keyType

enum<string>

requerido

Opciones disponibles:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

Ejemplo:

"CPF"

keyValue

string

requerido

Ejemplo:

"39053344705"

merchantCity

string

requerido

Ejemplo:

"Goiania"

merchantName

string

requerido

Ejemplo:

"Loja Teste"

organizationId

string

requerido

Ejemplo:

"0196a7b2-2d4e-7f50-9b01-234567890abc"

status

enum<string>

requerido

Opciones disponibles:

ACTIVE,

CANCELLED

Ejemplo:

"ACTIVE"

type

enum<string>

requerido

Opciones disponibles:

STATIC

Ejemplo:

"STATIC"

updatedAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

amount

string

Ejemplo:

"100.50"

currency

enum<string>

Opciones disponibles:

BRL

Ejemplo:

"BRL"

description

string

Ejemplo:

"Pagamento do pedido 12345"

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

Manejo de errores

Get a static BR Code by ID

Autorizaciones

Parámetros de ruta

Respuesta