Pular para o conteúdo principal
POST
Create a Static QR Code

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID (UUID format)

Parâmetros de consulta

include_base64
boolean
padrão:false

Returns the rendered QR code in base64 alongside the EMV payload

Corpo

application/json
clientRequestId
string
obrigatório

Idempotency token that will be echoed by BTG

Minimum string length: 1
Exemplo:

"8c4ffd09-a264-4779-8d7e-fd24c971d7ff"

receiverKey
string
obrigatório

Pix key that will receive the payment

Minimum string length: 1
Exemplo:

"+5511999999999"

amount
string

Fixed payment amount (optional, payer chooses if not provided)

Exemplo:

"100.00"

description
string

Custom message or description shown to the payer

Exemplo:

"Payment for order #12345"

merchant
object

Optional merchant metadata overrides

tags
string[]

Custom tags for categorization and correlation

Exemplo:
txId
string

Transaction identification (txid) to be sent on the payment message

Exemplo:

"ORDER-12345"

Resposta

Created

createdAt
string
obrigatório

Timestamp when the BR Code was created

Exemplo:

"2024-01-15T10:30:00Z"

emv
string
obrigatório

QR code payload in EMV format

Exemplo:

"000201010212..."

id
string
obrigatório

Unique identifier of the BR Code

Exemplo:

"550e8400-e29b-41d4-a716-446655440010"

receiverKey
string
obrigatório

Pix key that will receive the payment

Exemplo:

"+5511999999999"

amount
string

Fixed payment amount (optional)

Exemplo:

"100.00"

base64
string

Base64-encoded QR code image (when requested)

Exemplo:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."

description
string

Custom message or description shown to the payer

Exemplo:

"Payment for order #12345"

merchant
object

Merchant metadata for this BR Code

tags
string[]

Array of custom tags for categorization

Exemplo:
txId
string

Transaction identification (txid) sent on the payment message

Exemplo:

"ORDER-12345"