v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

QR Code

Get QR Code information and calculate payment

Get QR Code information and, at the same time, calculate payment information depending on query parameters passed.

get/v1/pix/qrcode/jws/{access-token}

Path parameters

access-tokenstring required

QR Code ID

Query parameters

desired-payment-datestring date

Payer's desired payment date. Format = yyyy-mm-dd. Default is current date.

payer-city-idstring

Payer city (in Brazil) dialing code identifier. Cities in Brazil can have their own holidays, which is needed to calculate fees and payment. Default city is Brasilia ("61").

Headers

Authorizationstring required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message

Response

Generate COB QR Code response

idstring required

Pismo QR Code identifier

access_tokenstring required

QR Code access token generated and returned at creation.

external_idstring required

Client-generated record identifier for client tracking and monitoring.

emvstring required

Base 64 encoded discount QR Code payload. EMV = Europay, Mastercard and Visa, a global standard for credit and debit payment. The EMV might include details required for secure transactions such as cardholder informatipn, transaction amount, merchant information, and other relevant data.

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD' required

CREATED - Payment has been created and is pending processing
PROCESSING - P2P balance was impacted and waiting for provider confirmation. For cashin, the transaction means the money will be credited on the next Working Day
SETTLED - Transaction completed processing and is settled
CANCELLED - Something went wrong and the transaction is cancelled. Refer to reason for more details
HOLD - The payment is on hold, pending further review

qrcode_imageb64string

Base64 encoded QR Code

versioninteger

Current version

jwsstring

JWS (JSON Web Signature) payload. When a JWT (JSON Web Token) is signed, it becomes a JWS.

creation_datestring datetime

QR Code creation date/time. RFC 3339 format.

last_updatestring datetime

When QR Code last updated. RFC 3339 format.

Example response

{
  "id": "442e992a-2f89-46fb-820a-958693bde84d",
  "access_token": "1234567890",
  "external_id": "my-external-id-9999-6474",
  "emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/...***63040441",
  "status": "PROCESSING",
  "qrcode_imageb64": "dfkk7830o*&#)@#9FEE",
  "version": 1,
  "jws": "eYqqqwq.heif.jk2w",
  "creation_date": "2023-04-12T23:20:50.52Z",
  "last_update": "2023-04-12T23:20:50.52Z"
}