---
title: "Encode BR Code"
method: POST
path: "/v1/emv/brcode/encode"
tags: ["BR Code"]
---

# Encode BR Code

`POST /v1/emv/brcode/encode`

## Request

- Base URL: `https://sandbox.pismolabs.io/qrcps`
- URL: `https://sandbox.pismolabs.io/qrcps/v1/emv/brcode/encode`
- Auth: none declared. Required headers: `x-cid`

Encode a Brazilian BR Code (short for "Brazilian Barcode") - a standard barcode format used in Brazil for electronic payments. It is part of the Brazilian Payment System (SPB) and is regulated by the Central Bank of Brazil. The BR Code contains information about the payee, transaction details, and other data.

A BR Code is typically used with [Pix](doc:pix-instant-payments), a Brazilian instant payments system. For more information about BR Codes, see <a href="https://www.bcb.gov.br/content/config/Documents/BR_Code_MANUAL_Version_2_May_2020.pdf" target="_blank">BR Code Manual</a>

## Headers

- `x-cid` string, required
- `x-tenant` string

## Request body

- BrcodeBarCode: Brcode object
  - `country_code` string, required: Country code - ISO 3166-1 alpha 2. For example: "BR" = Brazil
  - `merchant_account_information` BrcodeGenericSubBlock[], required: Merchant account information
    - `additional_information` string: Additional information in the BR Code content. Relies on ID 02 of the BR Code standards.
    - `gui` string: Globally unique identifier.
    - `items` string[]: BR Code properties. Example BR Code: `00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea45204000053039865802BR5903Pix6008BRASILIA62070503***63040576` All the chars inside a BR Code must respect the following rule: {ID-2chars}{SIZE-2chars}{VALUE-N}{ID-2chars}{SIZE-2chars}{VALUE-N}{ID-2chars}{SIZE-2chars}{VALUE-N}... For the BR Code example, it will be parsed to: {ID: "00", Size: 02, Value: "01"} {ID: "26", Size: 94, Value: "0014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea4"} The items list will look like this: <pre> [ "01", "0014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea4" ] </pre>
    - `key` string: Pix key.
    - `pss` string: Prestador de Serviço de Saque (PSS) means the Bank Brazilian payment system ID. Also known as an ISPB (Identifcador do Sistema de Pagamento Brazil) number, an 8-digit value.
    - `url` string: The URL location in the Pix DICT where the payment will be settled.
  - `merchant_category_code` string, required: ISO 18245 merchant category code.
  - `merchant_city` string, required: Merchant's city
  - `merchant_name` string, required: Merchant name
  - `additional_data_field_template` BrcodeAdditionalDataFieldTemplate, required
    - `reference_label` string: Reference label
  - `payload_format_indicator` string, required: For Brazilian BR Codes associated with Pix transactions, this is fixed at "01". This value indicates that the data following conforms to the Brazilan Payment System's specifications for Pix transactions.
  - `transaction_currency` integer, required: ISO 4217 transaction currency. For example: 986 = Brazilin Real
  - `point_initiation_method` string: Point initiation method. A value = "12" means that the BR Code can only be used once.
  - `postal_code` string: Código de Endereçamento Postal (CEP - Postal Addressing Code). 8 digits separated by a hyphen.
  - `transaction_amount` number: Transaction amount
  - `unreserved_templates` BrcodeGenericSubBlock[]: Unreserved template
    - `additional_information` string: Additional information in the BR Code content. Relies on ID 02 of the BR Code standards.
    - `gui` string: Globally unique identifier.
    - `items` string[]: BR Code properties. Example BR Code: `00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea45204000053039865802BR5903Pix6008BRASILIA62070503***63040576` All the chars inside a BR Code must respect the following rule: {ID-2chars}{SIZE-2chars}{VALUE-N}{ID-2chars}{SIZE-2chars}{VALUE-N}{ID-2chars}{SIZE-2chars}{VALUE-N}... For the BR Code example, it will be parsed to: {ID: "00", Size: 02, Value: "01"} {ID: "26", Size: 94, Value: "0014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea4"} The items list will look like this: <pre> [ "01", "0014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49818c82a55aa8312ea4" ] </pre>
    - `key` string: Pix key.
    - `pss` string: Prestador de Serviço de Saque (PSS) means the Bank Brazilian payment system ID. Also known as an ISPB (Identifcador do Sistema de Pagamento Brazil) number, an 8-digit value.
    - `url` string: The URL location in the Pix DICT where the payment will be settled.

## Response `200`

Success

- BrcodeMarshaled
  - `brcode` string: Encoded BR Code in EMV (Europay Mastercard and Visa) format.

## Other responses

- `400`: Success
- `500`: Success

---

[API](https://skmtc.dev/pismo/apis/instant-payments-br-code.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-br-code/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-br-code/revisions/e473dc0c5522?raw)