Skip to navigation

Issue a composite QR with due date (charge + recurrence)

Same as the static composite QR, with a due date and the optional deduction, discount, interest and penalty amounts.

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-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
identifierstringRequiredformat: "uuid"
Your UUID for the QR. Unique per account.
pixKeystringRequired
Pix key of the account that receives the payment.
valuedoubleRequired
Amount charged by the QR.
requestExpirationdatetimeRequired

Deadline of the recurrence offer: after today and up to 30 days ahead. Without an offset it is read in Brasília time.

recurrenceobjectRequired

Send exactly one of value or maximumValue.

dueDatedateRequired
messagestringOptional
payerobjectOptional
daysAfterDueDateintegerOptional>=0

Days the QR stays payable after dueDate.

deductiondoubleOptional
discountdoubleOptional
interestdoubleOptional
penaltydoubleOptional

Response

Composite QR issued
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional
statusenumOptional
identifierstringOptional
qrCodeIdstringOptional
pixCopyPastestringOptional
Pix copia e cola.
imagestringOptional

QR image (base64 PNG).

dueDatedateOptional
daysAfterDueDateintegerOptional
requestExpirationdatetimeOptional
createdAtdatetimeOptional

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
502
Bad Gateway Error