The global thank-you page is a single URL used to redirect your customer after they sign a document, pay an invoice, or pay a payment link.
The following variables can be added to the URL:
| Variable | Description |
|---|---|
{{type}} | The type of action: document, invoice, or link |
{{id}} | The identifier of the action (see below) |
{{ref}} | The reference of the action (see below) |
{{state}} | The outcome of the action (see below) |
{{id}}| Type | Value |
|---|---|
document | Document reference (mandate number, contract number) |
invoice | Invoice number |
link | Payment link ID |
{{ref}}| Type | Value |
|---|---|
document | Contract reference defined on the profile |
invoice | Invoice reference (ref parameter when creating via API or CSV) |
link | Payment link remittance |
{{state}}| Type | Value |
|---|---|
document | ok (signed), fail (error), pending (printed), cancel (cancelled) |
invoice | paid |
link | paid, declined (payment failed or cancelled) |
You can structure your URL in different ways depending on how much handling you want to do on your end:
https://mythankyoupage.com/{{type}}/index.htmlhttps://mythankyoupage.com/{{type}}.htmlhttps://mythankyoupage.com?type={{type}}&id={{id}}&ref={{ref}}When a global Thank-you page is configured, Twikey sends the URL directly to the payment service provider where applicable. The final redirect is handled by the PSP, which may enrich the URL with its own parameters.