GuidesCommunity
API Reference

Emit dynamic (instant) or static QR Codes

post
https://nightly-pix.btcore.app/wallets//qrcode

Generates a QR Code associated with a given wallet for a specific transaction.
It can generated static or dynamic QR Codes.

Path Params
uuid
required

The UUID of the wallet

Query Params
string
enum
required

The type of the QR Code to be generated

Allowed:
string
enum
required
Defaults to base64

The output format of the QR Code

Allowed:
Body Params
string

The amount of the transaction, if not specified, the user will be asked to input the value when the QR Code is scanned.

additionalData
object

Unstructured informations about the transaction

string
length between 4 and 4
Defaults to 0000

The Merchant Category Code(MCC)

string
required

If set, this will be the key that will be the destination of this QR Code.

externalAccount
object
string
required

The city of the user emitting the QR Code

string

The description of the QR Code for the user which will be paying

string
length ≤ 25

The ID of the transaction to be saved on the database, if omitted it will check in header for X-Transaction-Id

string

ISPB (used for PIX withdraw)

Headers
string
length between 1 and 35

The ID of the transaction to be saved on the database. The length is {1,25} for static qrcodes and {26,35} for dynamic qrcodes

Responses
201

Created

Updated over 3 years ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 3 years ago