Skip to main content

Generate QR code

Generate QR tramma that will be added to an image

All payload fields are optional. If no item is specified, a QR code will be generated without the amount included in the payload.

When the Prefer header is used to request PDF generation, the response will include additional headers:

  • Preference-Applied: return=pdf-base64 (when PDF generation is successful)
  • Preference-Not-Applied: return=pdf-base64; reason=not-enabled (when PDF generation is not supported)
Path Parameters
point_of_sale REQUIRED

Represents the point of sale (branch identifier of the business) to which the QR code will be associated.

Header Parameters
Prefer string

Possible values: [return=pdf-base64]

Client preferences for response format. Use 'return=pdf-base64' to request PDF generation.

Example: return=pdf-base64
Request Body REQUIRED

Data to generate a new QR tramma.

source string
type string

It must be one of the following values BANCARD, DEFAULT, GENERIC, PIX, DEPAY

items object[]
name string
amount string
quantity number
currency currencyCodeISO4217
metadata array
notification object
webhook_url string
Responses
200

Successful response

Schema OPTIONAL
id uuid OPTIONAL
hash string OPTIONAL
qr string OPTIONAL
pdf_base64 string OPTIONAL