APIs
Sub-processorsAbout PismoContact us

Encode BR Code

post
https://sandbox.pismolabs.io/qrcps/v1/emv/brcode/encode

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, a Brazilian instant payments system. For more information about BR Codes, see BR Code Manual

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Encode Brcode request body

Brcode object

string
required
length ≤ 2

Country code - ISO 3166-1 alpha 2. For example: "BR" = Brazil

merchant_account_information
array of objects
required

Merchant account information

merchant_account_information*
string
required
length ≤ 4

ISO 18245 merchant category code.

string
required
length ≤ 15

Merchant's city

string
required
length ≤ 25

Merchant name

additional_data_field_template
object
required
string
required
length ≤ 2

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.

integer
required
≤ 999

ISO 4217 transaction currency. For example: 986 = Brazilin Real

string
length ≤ 2

Point initiation method. A value = "12" means that the BR Code can only be used once.

string

Código de Endereçamento Postal (CEP - Postal Addressing Code). 8 digits separated by a hyphen.

number
≤ 9999999999999

Transaction amount

unreserved_templates
array of objects

Unreserved template

unreserved_templates
Headers
string
required

The Correlation IDentifier UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

string

Organization/tenant ID

Responses

Updated about 6 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?