Developer Documentation

Hosted Payment Page overview

Last Updated: 6 June 2023

What is a Hosted Payment Page?

A Hosted Payment Page allows you to direct shoppers to an external payment page, hosted by Truevo, for them to enter their payment credentials and securely complete purchases.

We host this page outside of your website on our secure servers. When a cardholder wants to make a payment on your website, you redirect them to the Truevo-hosted page. Truevo handles the payment end-to-end, including 3D-Secure verification, and automatically redirects the shopper back to your website upon completion.

A Hosted Payment Page allows you to remove the technicalities of processing payments, letting you focus on your business.

Benefits of a Hosted Payment Page

  1. Truevo takes care of the entire transaction process and provides a simple integration mechanism.
  2. Payments are processed independently on secure and reliable servers. This ensures that you can take payments at any time while keeping your customers’ sensitive information safe.
  3. The collection of payment information is performed by the host server. This reduces the security requirements imposed on you, making it much easier to remain PCI-DSS compliant.

How does a Hosted Payment Page work?

You’ll need to specify the details of the payment, redirect your shoppers to Truevo, and finally handle the result of the operation.

The steps are as follows:

  1. Make a request to the Truevo service to create a payment session. This will include the details of the payment, such as the amount and currency.
  2. Truevo will return the URL to the payment page configured as per the information supplied.
  3. You will hand over the process to Truevo by redirecting your shopper to the URL supplied.
  4. The cardholder will complete their purchase on the Truevo payment platform.
  5. Once payment is completed or has been aborted, Truevo will redirect the shopper back to your website.

As an added security measure, when a link for the Hosted Payment Page is created, it’s only valid for 15 minutes. This measure assists in preventing the misuse of these links.

How to integrate a Hosted Payment Page

When your customer loads a checkout page, follow these five steps:

  1. Create a Hosted Payment Page Session
  2. Receive your Hosted Payment Page URL
  3. Redirect your Customer to Hosted Payment Page URL
  4. Allow Customer to Complete the Purchase
  5. Receive the Transaction Result

1. Create a Hosted Payment Page session

You will need to start by creating a Hosted Payment Page session. To do this, make a PUT request to the payment page API endpoint, passing in the necessary payment information, such as a reference, payment amount, and the web page to return to after the payment has completed. Refer to our Hosted Payment Page parameters for more on the fields used to create a payment session.



Truevo will issue a merchant identifier (mid) and terminal identifier (tid) to be used in the requests.

Sample request

  "storeName": "The Camping Store",
  "successUrl": "",
  "failureUrl": "",
  "declinedUrl": "",
  "transaction": {
    "merchantReference": "Order 123",
    "paymentReference": "Camp Website",
    "amount": {
      "totalAmount": 0.99,
      "currencyAlphaCode": "EUR"
  "merchant": {
    "mid": "999999",
    "tid": "000000"

To ensure authenticity and integrity of the payment transaction, a digital signature can be supplied. Read how to create it on the digital signature algorithm page.

2. Receive your payment link

The API response will include the URL to which you must redirect the customer.

Sample Response

    "redirect_url": "",
    "outcome": {
        "status": "SUCCESS",
        "message": "Ok"

3. Redirect your customer to the Hosted Payment Page URL

Once you have the URL, redirect your customer to the Truevo-hosted payment page. All aspects of the payment transaction cycle will now be handled for you.

4. Accept the transaction result

Once your customer has filled in their payment card details, Truevo will process the transaction.

Depending on the outcome of the payment, Truevo will redirect your customer to a URL that you supplied in the body of the request in step 1. This will allow you to handle the result of the transaction.

These are the possible responses:

  • Payment Successful
  • Payment Declined
  • Payment Failed

A URL should be supplied for each.

The parameters Truevo will supply when returning to your website are illustrated below:



Redirect URL query string parameters

Parameter Description
Truevo’s unique identifier for the payment transaction using a GUID format.
A unique, numeric identifier that is passed on to Truevo’s payment host. This value can be used to query payment status with the card issuer.

One of:

  • COMPLETE - The transaction has been processed.
  • DECLINED - The transaction has been declined.
  • FAILURE - The transaction request was successfully received but failed to process, please retry.
The authorisation response code received for the transaction. This code can be used to identify the reason why a transaction failed or was declined.
The value that was passed as the merchantReference in the request sent to Truevo in step 1. This value can be used to reconcile with the order number or invoice number in your system.

Page Contents