Skip to navigation

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringRequired>=8 characters

Client-generated idempotency token.

Request

This endpoint expects an object.
pixKeystringRequired

PIX key of the receiving account (must be registered to the account).

valuedoubleRequired>=0.01
Original charge amount in BRL.
dueDatedateRequired

Due day (YYYY-MM-DD, Brasília). Cannot be in the past.

debtorobjectRequired

Debtor of a due-date or Location charge. Who actually paid comes in payer after payment.

identifierstringOptional<=38 characters

Unique charge identifier ([A-Za-z0-9._-], up to 38 characters). When omitted the API generates one (a UUID without hyphens).

daysAfterDueDateintegerOptional>=0Defaults to 0
For how many days after the due date the QR still accepts payment.
deductiondoubleOptional>=0
Deduction in BRL.
discountdoubleOptional>=0
Discount in BRL for payment up to the due date.
interestdoubleOptional>=0
Interest in BRL for payment after the due date.
penaltydoubleOptional>=0
Penalty in BRL for payment after the due date.
finalValuedoubleOptional>=0

Amount to pay up to the due date. When omitted, value − deduction − discount.

receiverNamestringOptional
Receiver name shown to the payer. When omitted, the account holder name.
messagestringOptional<=140 characters
Message displayed to the payer.

Response

QR code with due date generated successfully.
txidstring

QR code transaction ID (used as qrcodeId).

emvstring

EMV PIX copy-and-paste code (BR Code). Render this as the QR / “copia e cola”.

typeenum
Allowed values:
statusstring

QR status. ACTIVE right after creation; BLOCKED for a Location QR until it is confirmed.

identifierstring

Client-provided identifier (use for lookups).

valuedoubleOptional
Charge amount in BRL.
messagestringOptional
Message shown to the payer.
descriptionstringOptional

Same as message (alias).

accountIdstringOptional
Account that owns the charge.
pixKeystringOptional
PIX key used in the charge.
allowChangebooleanOptional
Whether the payer may change the amount.
createdAtdatetimeOptional
expiresAtdatetimeOptional

Last instant the QR accepts payment. For due-date and Location QR codes, the end of dueDate + daysAfterDueDate (Brasília).

locationIdstringOptional

Location QR identifier at the settlement bank (Location QR only). Accepted instead of identifier on confirmation.

dueDatedateOptional

Due day (due-date and confirmed Location QR only).

daysAfterDueDateintegerOptional

Days after the due date the QR still accepts payment (due-date and confirmed Location QR only).

deductiondoubleOptional

Deduction in BRL (due-date and confirmed Location QR only).

discountdoubleOptional

Discount in BRL (due-date and confirmed Location QR only).

interestdoubleOptional

Interest in BRL (due-date and confirmed Location QR only).

penaltydoubleOptional

Penalty in BRL (due-date and confirmed Location QR only).

finalValuedoubleOptional

Amount to pay up to the due date (due-date and confirmed Location QR only).

debtorobjectOptional

Debtor given at issuance (due-date and confirmed Location QR only).

receiverNamestringOptional

Receiver name shown to the payer (due-date and confirmed Location QR only).

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error
502
Bad Gateway Error