PIpismo
BR Code

Decode BR Code

Decode a Brazilian BR Code.

post/v1/emv/brcode/decode

Request

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

Headers

x-cidstring 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.

x-tenantstring

Organization/tenant ID

Request body

brcodestring

Encoded BR Code in EMV (Europay Mastercard and Visa) format.

Response

Success

country_codestring required

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

merchant_category_codestring required

ISO 18245 merchant category code.

merchant_citystring required

Merchant's city

merchant_namestring required

Merchant name

payload_format_indicatorstring 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_currencyinteger required

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

point_initiation_methodstring

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

postal_codestring

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

transaction_amountnumber

Transaction amount

Example response

{
  "country_code": "BR",
  "merchant_account_information": [
    {
      "gui": "BR.COM.OTHER",
      "key": "123e4567-e12b-12d1-a456-426655440000",
      "pss": "86753009",
      "url": "br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49"
    }
  ],
  "merchant_category_code": "5446",
  "merchant_city": "Brasilia",
  "merchant_name": "Acme Widgets",
  "payload_format_indicator": "01",
  "transaction_currency": 986,
  "point_initiation_method": "12",
  "postal_code": "86753-090",
  "transaction_amount": 86753.09,
  "unreserved_templates": [
    {
      "gui": "BR.COM.OTHER",
      "key": "123e4567-e12b-12d1-a456-426655440000",
      "pss": "86753009",
      "url": "br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v1/dde3049e944b49"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.