v1

latestOpenAPI 3.1.02026-08-0629140119.9 KB

PIX QR Codes

Get Dynamic QR Code Details

Retrieves details of a specific dynamic PIX QR code by its ID.

get/v1/dynamic-qrcode/{id}

Path parameters

idstring uuid required

QR code identifier

Response

QR code details retrieved successfully

accept_change_valueboolean required

Allows payer to change the QR code value when scanning

allowed_tax_idsstring[] required

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

amount_in_centsinteger required

Amount in cents

copy_paste_codestring required

PIX copy-paste code (BR Code)

created_atstring date-time required

QR Code creation timestamp (UTC, RFC 3339).

due_datestring date nullable

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

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

status'waiting_payment' | 'paid' | 'cancelled' required

type'INSTANT' | 'DUE_DATE' required

updated_atstring date-time required

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

Example response

{
  "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",
  "due_date": "2026-06-01",
  "external_reference_id": "order-12345",
  "payer_data": {
    "document_number": "012.345.678-90",
    "name": "João Silva"
  },
  "transaction": {
    "completed_at": "2026-05-28T14:30:00Z",
    "created_at": "2026-05-28T14:30:00Z",
    "details": {
      "value": {
        "due_date": "2026-06-01",
        "paid_at": "2026-05-28T14:30:00Z"
      }
    },
    "end_to_end_id": "E323070002024011012345612345678901234",
    "med": {
      "incoming_infraction": {
        "created_at": "2026-05-28T14:30:00Z",
        "deadline": "2026-05-28T14:30:00Z",
        "funds_recovery": {
          "closed_at": "2026-05-28T14:30:00Z",
          "external_created_at": "2026-05-28T14:30:00Z",
          "external_last_modified_at": "2026-05-28T14:30:00Z"
        },
        "original_transaction": {
          "created_at": "2026-05-28T14:30:00Z"
        }
      },
      "outgoing_dispute": {
        "cancellation_requested_at": "2026-05-28T14:30:00Z",
        "created_at": "2026-05-28T14:30:00Z",
        "deadline": "2026-05-28T14:30:00Z",
        "funds_recovery": {
          "closed_at": "2026-05-28T14:30:00Z",
          "external_created_at": "2026-05-28T14:30:00Z",
          "external_last_modified_at": "2026-05-28T14:30:00Z"
        },
        "original_transaction": {
          "created_at": "2026-05-28T14:30:00Z"
        }
      }
    }
  },
  "updated_at": "2026-05-28T14:30:00Z"
}