Skip to main content
GET
/
v1
/
dynamic-qrcode
/
{id}
Get Dynamic QR Code Details
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id} \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
{
  "accept_change_value": false,
  "allowed_tax_ids": [
    "012.345.678-90",
    "45.059.493/0001-73"
  ],
  "amount_in_cents": 4000,
  "copy_paste_code": "00020126...",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "picture_code_base64": "<string>",
  "status": "initial",
  "transaction_id": "abcdefghijklmnopqrstuvwxyz",
  "type": "INSTANT",
  "updated_at": "2023-11-07T05:31:56Z",
  "due_date": "2026-12-31",
  "external_reference_id": "order-12345",
  "payer_data": {
    "document_number": "012.345.678-90",
    "document_type": "cpf",
    "name": "João Silva"
  }
}

Authorizations

​
x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Path Parameters

​
id
string<uuid>
required

QR code identifier

Response

QR code details retrieved successfully

​
accept_change_value
boolean
required

Allows payer to change the QR code value when scanning

Example:

false

​
allowed_tax_ids
string[]
required

List of CPF/CNPJ allowed to pay

Example:
["012.345.678-90", "45.059.493/0001-73"]
​
amount_in_cents
integer<int64>
required

Amount in cents

Example:

4000

​
copy_paste_code
string
required

PIX copy-paste code (BR Code)

Example:

"00020126..."

​
created_at
string<date-time>
required

QR Code creation timestamp

​
id
string<uuid>
required

Unique QR Code identifier

​
picture_code_base64
string
required

QR Code image in base64 format

​
status
enum<string>
required

QR Code status: active, cancelled, or completed

Available options:
initial,
active,
completed,
cancelled
​
transaction_id
string
required

Transaction ID (Bacen txId) used for QR code conciliation

Example:

"abcdefghijklmnopqrstuvwxyz"

​
type
enum<string>
required

QR Code type: INSTANT or DUE_DATE

Available options:
INSTANT,
DUE_DATE
​
updated_at
string<date-time>
required

QR Code last update timestamp

​
due_date
string<date> | null

Due date in YYYY-MM-DD format (for DUE_DATE type)

Example:

"2026-12-31"

​
external_reference_id
string | null

External reference ID provided by the client (if any)

Example:

"order-12345"

​
payer_data
object

Payer information (required for DUE_DATE type)