Hosted invoices
Let customers review and pay an existing invoice through its hosted link.
Start with an existing invoice
The hosted invoice V6 page at /i/{invoiceToken} represents an existing invoice. Share the URL RevKeen returned for that invoice. Do not turn an invoice UUID into a token, and do not create a Checkout Session or Cart convert merely to collect the same receivable.
The customer reviews merchant and customer details, invoice line items, discounts, tax, currency, amount due, and available payment methods. Line items, PDF, and receipt must describe the same invoice; if they disagree, treat the server invoice retrieve as source of truth and contact support with the invoice UUID. The invoice state determines whether a payment action is available.
Wallet sheets on this page, when shown, use the invoice amount due — not a separate checkout quote.
Payment and receipt states
| State | What to communicate |
|---|---|
| Amount remains due | Review the balance and choose an eligible method. |
| Partial payment | Show the remaining amount due. Do not create a second invoice for the remainder. |
| Card authentication or processing | Complete the required step; retrieve current state before another attempt. |
| Direct Debit scheduled or pending | Show the collection status/date. Do not describe the invoice as settled. |
| Paid | Show the recorded payment and receipt; fulfil according to your server's confirmed state. |
| Refunded | Show the refunded amount against this invoice. A credit note is a separate billing correction. |
| Void, expired, or no longer payable | Explain the state and contact the merchant for a valid link. |
An already scheduled Direct Debit collection can suppress the card Pay now action to prevent duplicate collection. Use the invoice Direct Debit journey and retain advance-notice requirements.
invoiceId on Checkout Session create is not a substitute for this page. If you already have a hosted invoice token, send the customer to /i/{invoiceToken}.
Developer integration
Retrieve an invoice with GET /v2/invoices/{id} using your merchant server credential. Use UUIDs where the request schema requires them and follow the operation's response fields. Verify webhooks before updating fulfilment; the customer's return to your website is not settlement evidence.
For a billing correction, use a credit note. A credit note, a refund to a payment method, and cancelling a Direct Debit mandate are distinct actions.
Next: Customer Portal for ongoing invoice and payment-method access.