Generate Pix QR with due date for an account
Creates a PIX charge with a due date (CobV): a single-use QR code with a
debtor and optional deduction, discount, interest and penalty. The QR
accepts payment until 23:59:59 (Brasília) of dueDate + daysAfterDueDate, at most 365 days ahead. Lookup, cancellation and
webhooks are the same as for the dynamic QR; qrcode.paid carries the
amount actually paid. Requires the product to be enabled for the tenant
(403 feature_disabled otherwise).
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Client-generated idempotency token.
Request
PIX key of the receiving account (must be registered to the account).
Due day (YYYY-MM-DD, Brasília). Cannot be in the past.
Debtor of a due-date or Location charge. Who actually paid comes in payer after payment.
Unique charge identifier ([A-Za-z0-9._-], up to 38 characters).
When omitted the API generates one (a UUID without hyphens).
Amount to pay up to the due date. When omitted, value − deduction − discount.
Response
QR code transaction ID (used as qrcodeId).
EMV PIX copy-and-paste code (BR Code). Render this as the QR / “copia e cola”.
QR status. ACTIVE right after creation; BLOCKED for a Location QR until it is confirmed.
Client-provided identifier (use for lookups).
Same as message (alias).
Last instant the QR accepts payment. For due-date and Location QR codes, the end of dueDate + daysAfterDueDate (Brasília).
Location QR identifier at the settlement bank (Location QR only). Accepted instead of identifier on confirmation.
Due day (due-date and confirmed Location QR only).
Days after the due date the QR still accepts payment (due-date and confirmed Location QR only).
Deduction in BRL (due-date and confirmed Location QR only).
Discount in BRL (due-date and confirmed Location QR only).
Interest in BRL (due-date and confirmed Location QR only).
Penalty in BRL (due-date and confirmed Location QR only).
Amount to pay up to the due date (due-date and confirmed Location QR only).
Debtor given at issuance (due-date and confirmed Location QR only).
Receiver name shown to the payer (due-date and confirmed Location QR only).