Pular para o conteúdo principal
GET
/
v1
/
dynamic-qrcode
/
{id}
Ver QR Code Dinâmico
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>'
import requests

url = "https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}"

headers = {
"x-access-id": "<api-key>",
"X-PoP-Challenge": "<api-key>",
"X-PoP-Format": "<api-key>",
"X-PoP-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {
'x-access-id': '<api-key>',
'X-PoP-Challenge': '<api-key>',
'X-PoP-Format': '<api-key>',
'X-PoP-Signature': '<api-key>'
}
};

fetch('https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-PoP-Challenge: <api-key>",
"X-PoP-Format: <api-key>",
"X-PoP-Signature: <api-key>",
"x-access-id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-access-id", "<api-key>")
req.Header.Add("X-PoP-Challenge", "<api-key>")
req.Header.Add("X-PoP-Format", "<api-key>")
req.Header.Add("X-PoP-Signature", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}")
.header("x-access-id", "<api-key>")
.header("X-PoP-Challenge", "<api-key>")
.header("X-PoP-Format", "<api-key>")
.header("X-PoP-Signature", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://conta-public-api.kiwify.com/v1/dynamic-qrcode/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-id"] = '<api-key>'
request["X-PoP-Challenge"] = '<api-key>'
request["X-PoP-Format"] = '<api-key>'
request["X-PoP-Signature"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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": "2026-05-28T14:30:00Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "picture_code_base64": "<string>",
  "updated_at": "2026-05-28T14:30:00Z",
  "due_date": "2026-06-01",
  "external_reference_id": "order-12345",
  "payer_data": {
    "document_number": "012.345.678-90",
    "name": "João Silva"
  },
  "transaction": {
    "amount_in_cents": 123,
    "created_at": "2026-05-28T14:30:00Z",
    "description": "<string>",
    "details": {
      "type": "Pix",
      "value": {
        "receiver": {
          "account_number": "<string>",
          "bank": "<string>",
          "bank_code": "<string>",
          "document": "<string>",
          "name": "<string>"
        },
        "sender": {
          "account_number": "<string>",
          "bank": "<string>",
          "bank_code": "<string>",
          "document": "<string>",
          "name": "<string>"
        },
        "message": "<string>",
        "pix_key": "<string>"
      }
    },
    "end_to_end_id": "E323070002024011012345612345678901234",
    "id": 123,
    "type": "<string>",
    "completed_at": "2026-05-28T14:30:00Z",
    "counterparty": "<string>",
    "med": {
      "can_be_disputed": true,
      "incoming_infraction": {
        "created_at": "2026-05-28T14:30:00Z",
        "end_to_end_id": "<string>",
        "id": 123,
        "original_amount_in_cents": 123,
        "original_transaction": {
          "created_at": "2026-05-28T14:30:00Z",
          "counterparty_name": "<string>"
        },
        "refunded_amount_in_cents": 123,
        "transaction_id": 123,
        "deadline": "2026-05-28T14:30:00Z",
        "funds_recovery": {
          "external_id": "<string>",
          "closed_at": "2026-05-28T14:30:00Z",
          "contact_email": "<string>",
          "contact_phone": "<string>",
          "external_created_at": "2026-05-28T14:30:00Z",
          "external_last_modified_at": "2026-05-28T14:30:00Z",
          "report_details": "<string>",
          "reporter_participant": "<string>",
          "root_transaction_id": "<string>"
        }
      },
      "outgoing_dispute": {
        "created_at": "2026-05-28T14:30:00Z",
        "end_to_end_id": "<string>",
        "id": 123,
        "original_amount_in_cents": 123,
        "original_transaction": {
          "created_at": "2026-05-28T14:30:00Z",
          "counterparty_name": "<string>"
        },
        "refunded_amount_in_cents": 123,
        "transaction_id": 123,
        "cancellation_requested_at": "2026-05-28T14:30:00Z",
        "deadline": "2026-05-28T14:30:00Z",
        "funds_recovery": {
          "external_id": "<string>",
          "closed_at": "2026-05-28T14:30:00Z",
          "contact_email": "<string>",
          "contact_phone": "<string>",
          "external_created_at": "2026-05-28T14:30:00Z",
          "external_last_modified_at": "2026-05-28T14:30:00Z",
          "report_details": "<string>",
          "reporter_participant": "<string>",
          "root_transaction_id": "<string>"
        }
      }
    }
  }
}
{
"error": {
"code": "INVALID_REQUEST",
"message": "<string>",
"details": {}
},
"timestamp": "2026-05-28T14:30:00Z"
}
{
"error": {
"code": "INVALID_REQUEST",
"message": "<string>",
"details": {}
},
"timestamp": "2026-05-28T14:30:00Z"
}
{
"error": {
"code": "INVALID_REQUEST",
"message": "<string>",
"details": {}
},
"timestamp": "2026-05-28T14:30:00Z"
}

Autorizações

x-access-id
string
header
obrigatório

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

X-PoP-Challenge
string
header
obrigatório

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

X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

X-PoP-Signature
string
header
obrigatório

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

Parâmetros de caminho

id
string<uuid>
obrigatório

QR code identifier

Resposta

QR code details retrieved successfully

accept_change_value
boolean
obrigatório

Allows payer to change the QR code value when scanning

Exemplo:

false

allowed_tax_ids
string[]
obrigatório

List of CPF/CNPJ allowed to pay this QR code. Empty if unrestricted.

Exemplo:
["012.345.678-90", "45.059.493/0001-73"]
amount_in_cents
integer<int64>
obrigatório

Amount in cents

Exemplo:

4000

copy_paste_code
string
obrigatório

PIX copy-paste code (BR Code)

Exemplo:

"00020126..."

created_at
string<date-time>
obrigatório

QR Code creation timestamp (UTC, RFC 3339).

Exemplo:

"2026-05-28T14:30:00Z"

id
string<uuid>
obrigatório

Unique QR Code identifier

picture_code_base64
string
obrigatório

QR Code image in base64 format

status
enum<string>
obrigatório

QR Code status: active, cancelled, or completed

Opções disponíveis:
waiting_payment,
paid,
cancelled
type
enum<string>
obrigatório

QR Code type: INSTANT or DUE_DATE

Opções disponíveis:
INSTANT,
DUE_DATE
updated_at
string<date-time>
obrigatório

QR Code last update timestamp (UTC, RFC 3339).

Exemplo:

"2026-05-28T14:30:00Z"

due_date
string<date> | null

Due date (YYYY-MM-DD). Present for DUE_DATE type QR codes.

Exemplo:

"2026-06-01"

external_reference_id
string | null

External reference ID provided by the client (if any)

Exemplo:

"order-12345"

payer_data
null | object

Payer information (required for DUE_DATE type)

transaction
null | object

Most recent transaction that paid this QR code.