Skip to navigation

Confirm Pix Location QR for an account

Confirms a blocked Pix Location QR code with the charge terms (amount, due date, debtor and optional charges) and releases it for payment. The emv does not change. The PIX key and the identifier are always the ones from generation. When the settlement bank refuses the confirmation, the error carries details.qrStatus: BLOCKED: the QR stays blocked and can be confirmed again; the refusal is recorded in the timeline as qrcode.location_confirm_failed. A confirmation already in progress for the same QR returns 409 invalid_state. If the settlement bank does not answer and its state cannot be checked, the error comes without details.qrStatus: look the QR up before confirming again.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.
identifierstringRequired

The identifier used at generation, or the locationId returned by it.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

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

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Request

This endpoint expects an object.
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.

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

Location QR code confirmed; it now accepts payment.

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
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error
502
Bad Gateway Error