KIkiwify
PIX QR Codes

Create Dynamic QR Code

Allowed Payers (allowed_tax_ids)

When allowed_tax_ids is provided, only payers whose CPF/CNPJ matches one of the listed values will be accepted at payment time. When omitted or null, payments from any document are accepted.

post/v1/dynamic-qrcode

Request

  • Base URL
    https://conta-public-api.kiwify.com
  • URL
    https://conta-public-api.kiwify.com/v1/dynamic-qrcode
  • Auth
    API key in header x-access-id and API key in header X-PoP-Challenge and API key in header X-PoP-Format and API key in header X-PoP-Signature

Request body

accept_change_valueboolean nullable

Allows payer to change the QR code value when scanning. Defaults to false.

allowed_tax_idsstring[] nullable

Optional allowlist of CPF/CNPJ (with or without formatting) that restricts which payers can use this QR code. Leave this null/omitted unless you specifically need to restrict who can pay. Do not set it from the buyer's document: a Pix payment may legitimately come from another account (for example, a family member) and would then be rejected. When provided, only payers whose document matches one of the listed values are accepted. When omitted or null, payments from any document are accepted.

amount_in_centsinteger required

Amount in cents (must be greater than 0)

due_datestring date nullable

Due date in YYYY-MM-DD format. Required for DUE_DATE type.

expirationinteger nullable

Expiration time in seconds for INSTANT type. Defaults to 86400 (24 hours).

external_reference_idstring nullable

External unique identifier for client's own tracking. Must be unique per account if provided.

type'INSTANT' | 'DUE_DATE' required

Example request

{
  "allowed_tax_ids": [
    "012.345.678-90",
    "45.059.493/0001-73"
  ],
  "amount_in_cents": 4000,
  "due_date": "2026-06-01",
  "expiration": 86400,
  "external_reference_id": "external-ref-123",
  "payer_data": {
    "document_number": "012.345.678-90",
    "name": "João Silva"
  }
}

Response

Dynamic QR code created successfully

copy_pastestring required

PIX copy-paste code (BR Code)

external_reference_idstring nullable

External reference ID provided by the client (if any)

idstring uuid required

Unique QR Code identifier

picture_code_base64string required

QR Code image in base64 format

Example response

{
  "copy_paste": "00020126...",
  "external_reference_id": "order-12345"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.