Create a static BR Code

curl --request POST \
  --url https://api.example.com/cob-hub/v1/brcodes/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "keyType": "CPF",
  "keyValue": "39053344705",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "amount": "100.50",
  "description": "Pagamento",
  "postalCode": "74000000",
  "txId": "TX12345"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"39053344705\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"amount\": \"100.50\",\n  \"description\": \"Pagamento\",\n  \"postalCode\": \"74000000\",\n  \"txId\": \"TX12345\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    keyType: 'CPF',
    keyValue: '39053344705',
    merchantCity: 'Goiania',
    merchantName: 'Loja Teste',
    amount: '100.50',
    description: 'Pagamento',
    postalCode: '74000000',
    txId: 'TX12345'
  })
};

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

import requests

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

payload = {
    "keyType": "CPF",
    "keyValue": "39053344705",
    "merchantCity": "Goiania",
    "merchantName": "Loja Teste",
    "amount": "100.50",
    "description": "Pagamento",
    "postalCode": "74000000",
    "txId": "TX12345"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "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": "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"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0016",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The request body must be sent with Content-Type: application/json.",
  "code": "PIX-0016"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0201",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Pix key does not exist or is not active.",
  "code": "PIX-0201"
}

{
  "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"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0223",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Provider adapter is unreachable.",
  "code": "PIX-0223"
}

{
  "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"
  }
}

POST

brcodes

static

Create a static BR Code

curl --request POST \
  --url https://api.example.com/cob-hub/v1/brcodes/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "keyType": "CPF",
  "keyValue": "39053344705",
  "merchantCity": "Goiania",
  "merchantName": "Loja Teste",
  "amount": "100.50",
  "description": "Pagamento",
  "postalCode": "74000000",
  "txId": "TX12345"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"keyType\": \"CPF\",\n  \"keyValue\": \"39053344705\",\n  \"merchantCity\": \"Goiania\",\n  \"merchantName\": \"Loja Teste\",\n  \"amount\": \"100.50\",\n  \"description\": \"Pagamento\",\n  \"postalCode\": \"74000000\",\n  \"txId\": \"TX12345\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    keyType: 'CPF',
    keyValue: '39053344705',
    merchantCity: 'Goiania',
    merchantName: 'Loja Teste',
    amount: '100.50',
    description: 'Pagamento',
    postalCode: '74000000',
    txId: 'TX12345'
  })
};

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

import requests

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

payload = {
    "keyType": "CPF",
    "keyValue": "39053344705",
    "merchantCity": "Goiania",
    "merchantName": "Loja Teste",
    "amount": "100.50",
    "description": "Pagamento",
    "postalCode": "74000000",
    "txId": "TX12345"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "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": "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"
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The Idempotency-Key header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0016",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "The request body must be sent with Content-Type: application/json.",
  "code": "PIX-0016"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0201",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Pix key does not exist or is not active.",
  "code": "PIX-0201"
}

{
  "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"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0223",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Provider adapter is unreachable.",
  "code": "PIX-0223"
}

{
  "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.

Encabezados

X-Idempotency

string

requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

X-Account-Id

string

requerido

Merchant account UUID (scopes DICT key ownership validation)

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Cuerpo

application/json

keyType

string

requerido

Pix key type

Ejemplo:

"CPF"

keyValue

string

requerido

Pix key value

Ejemplo:

"39053344705"

merchantCity

string

requerido

Merchant city

Ejemplo:

"Goiania"

merchantName

string

requerido

Merchant name

Ejemplo:

"Loja Teste"

amount

string

Fixed amount in BACEN-canonical decimal form (omit for open value)

Ejemplo:

"100.50"

description

string

Free-form description

Ejemplo:

"Pagamento"

postalCode

string

8-digit postal code

Ejemplo:

"74000000"

txId

string

Optional merchant transaction identifier

Ejemplo:

"TX12345"

Respuesta

Created

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

Create a static BR Code

Autorizaciones

Encabezados

Cuerpo

Respuesta