How It Works
1
Customer Completes Checkout
The customer submits a payment via
POST /payments as described in the Create a Payment guide. Nova.Pay processes the charge and returns a PaymentResult object.2
Check for an Upsell Offer
If the checkout page has an upsell product configured and the payment was successful, the If
PaymentResult response will include an offer field. This value is a signed GlobalID (SGID) — a time-limited, single-use token that authorises the upsell charge.offer is absent from the response, either the checkout page has no upsell configured or the payment did not succeed.3
Present the Upsell in Your UI
Display the upsell offer to the customer immediately after payment confirmation — for example, in a modal or a dedicated confirmation page section. Show the product name, price, and a clear call-to-action button.
4
Submit the Upsell if the Customer Accepts
If the customer clicks the upsell call-to-action, POST the The
offer SGID to the /upsell endpoint. Nova.Pay charges the original payment method on file — no additional card data is required.Endpoint: POST /upsellThe
POST /upsell endpoint is not host-restricted. You can call it from your server or directly from the customer’s browser.meta object is optional and can carry any key-value pairs you want to associate with this upsell event (e.g. UI placement, A/B test variant).Upsell Response Fields
A successfulPOST /upsell call returns an UpsellResult object.
Status of the upsell order (e.g.
"paid", "pending", "refused"). Handle "refused" gracefully — the customer’s card may have been declined for the additional charge.Array of gateway-level payment IDs created for the upsell order.
URL to the generated boleto PDF for the upsell order. Present only if the original order was paid via boleto.
Base64-encoded Pix QR code image for the upsell order. Present only if the original order was paid via Pix.
Hosted URL for the Pix QR code image of the upsell order. Present only if the original order was paid via Pix.
ISO 8601 timestamp indicating when the upsell Pix QR code expires. Present only if the original order was paid via Pix.