$wsComputopHosted - Computop (hosted payment page)

With the $wsComputopHosted module, you process payments via the hosted Computop payment page. The module provides all the data you need to redirect the customer to the Computop payment page via form, and reports after the return whether the payment was successful. This page covers providing the form data and evaluating the result. The actual payment processing runs on the Computop side; the configuration of the interface (merchant ID, keys) is done in the payment configuration.

Basic concept

With a hosted payment page, the payment does not take place in the shop but on a page of the payment provider. $wsComputopHosted provides the data with which you redirect the customer there. The flow is always the same: build the form → submit → Computop processes → evaluate the return.

You build an HTML form whose action points to $wsComputopHosted.action, and place the remaining values (data, len, merchantID, encryptionType …) as hidden fields.
The customer submits the form and is taken to the Computop payment page.
Computop processes the payment and redirects the customer back to the shop.
After the return, you evaluate paymentCanceled, paymentFailed, and error to give the customer appropriate feedback.

Pass encrypted data through unchanged

The fields data, len, and encryptionType form the encrypted payment data. You do not calculate anything yourself and do not modify them; you pass the values on to Computop unchanged.

Module overview

Example / excerpt of $wsComputopHosted

{{= $wsComputopHosted | json }}

JSON output

{
  "action": "",
  "data": "",
  "encryptionType": "AES",
  "error": "",
  "freeFields": [],
  "language": "",
  "len": "0",
  "merchantID": "",
  "payType": "",
  "paymentCanceled": false,
  "paymentFailed": false,
  "template": ""
}

Note: Conditional variables only appear when they are set: hideSave, prefill, and the data of a stored credit card (PCNr, PCNrBrand, PCNrYear, PCNrMonth, holder). Variables for building the form

Variable	Type	Description
`action`	string	URL of the Computop payment page (as the form’s `action`).
`data`	string	Encrypted payment data.
`len`	string	Length of the encrypted data (for validation at Computop).
`encryptionType`	string	Encryption type: `"Blowfish"` or `"AES"`.
`merchantID`	string	Merchant ID with Computop.
`payType`	string	Payment method (e.g. credit card).
`language`	string	Language code for the payment page (e.g. `"de"`).
`template`	string	Name of the Computop template.
`hideSave`	string	Contains `"hideSave"` when the save option is to be hidden. Only present in that case.
`prefill`	string	Contains `"on"` when the save option should be pre-selected (checked). Only present in that case.
`freeFields`	array	Free checkout fields transmitted to Computop (structure see below).

Variables of a stored credit card (only present when a stored pseudo credit card is selected)

Variable	Type	Description
`PCNr`	string	Pseudo card number (token) of the stored card.
`PCNrBrand`	string	Card brand (e.g. Visa).
`PCNrYear`	string	Expiry year of the card.
`PCNrMonth`	string	Expiry month of the card.
`holder`	string	Cardholder.

Variables for evaluating the result

Variable	Type	Description
`paymentCanceled`	bool	`true` if the payment was canceled.
`paymentFailed`	bool	`true` if the payment failed.
`error`	string	Error message in the event of a payment problem.

Templates

The redirect form is typically embedded in the checkout, i.e. on the page from which the customer is redirected to the payment. You evaluate the result variables on the page to which Computop redirects after the payment.

Variables

$wsComputopHosted.action

Returns the URL of the Computop payment page. You use it as the action attribute of the form with which the customer is redirected to the payment.

<form method="post" action="{{= $wsComputopHosted.action }}">
  ...
</form>

$wsComputopHosted.data

Returns the encrypted payment data. You submit it as a hidden form field – unchanged (see Basic concept).

<input type="hidden" name="Data" value="{{= $wsComputopHosted.data }}">

$wsComputopHosted.len

Returns the length of the encrypted data. Computop needs this value to validate the submitted data.

<input type="hidden" name="Len" value="{{= $wsComputopHosted.len }}">

$wsComputopHosted.encryptionType

Returns the encryption type used to encrypt data: "Blowfish" or "AES" — depending on what is configured in the Computop settings (default: Blowfish).

Encryption: {{= $wsComputopHosted.encryptionType }}

$wsComputopHosted.merchantID

Returns the merchant ID with Computop. It is submitted with the form so that Computop can assign the payment to the correct merchant account.

<input type="hidden" name="MerchantID" value="{{= $wsComputopHosted.merchantID }}">

$wsComputopHosted.payType

Returns the payment method (e.g. credit card).

Payment method: {{= $wsComputopHosted.payType }}

$wsComputopHosted.language

Returns the language code for the payment page. With it, the Computop page appears in the customer’s language.

Language: {{= $wsComputopHosted.language }}

$wsComputopHosted.template

Returns the name of the Computop template used.

Template: {{= $wsComputopHosted.template }}

$wsComputopHosted.hideSave

Returns the value for controlling the save option on the Computop payment page. The variable contains the text "hideSave" and is only present when the option is to be hidden — in two cases:

The customer is paying with an already stored credit card (see PCNr) — saving again is unnecessary.
Saving is not possible because the customer is not logged in or because saving pseudo credit card data is not enabled for the shop.

{{ if $wsComputopHosted.hideSave }}
  <!-- Hide save option -->
{{ /if }}

$wsComputopHosted.prefill

Contains the value "on" when the save option on the Computop payment page should be checked by default (configurable in the Computop configuration). Only present in that case.

{{ if $wsComputopHosted.prefill }}
  <input type="hidden" name="Prefill" value="{{= $wsComputopHosted.prefill }}">
{{ /if }}

$wsComputopHosted.PCNr / PCNrBrand / PCNrYear / PCNrMonth / holder

Return the data of a stored pseudo credit card so that the customer does not have to re-enter their card data. The variables are only present when all preconditions are met:

The customer is logged in,
saving pseudo credit card data is enabled for the shop,
and the customer has selected a stored card during checkout (see $wsCheckout.selectedPseudoCC).

PCNr (pseudo card number) is always set; the other variables only appear when the corresponding value is stored on the card. If PCNr is present, hideSave is also set, since the card has already been saved.

{{ if $wsComputopHosted.PCNr }}
  Stored card: {{= $wsComputopHosted.PCNrBrand }} ({{= $wsComputopHosted.holder }}),
  valid until {{= $wsComputopHosted.PCNrMonth }}/{{= $wsComputopHosted.PCNrYear }}
{{ /if }}

$wsComputopHosted.freeFields

Returns the free checkout fields that are submitted to Computop. Only the free checkout fields whose ID is listed under freeFields in the Computop payment configuration are transmitted.

Properties of a free field

Property	Type	Description
`id`	string	ID of the free checkout field.
`value`	string	Current value of the field.
`type`	string	Field type: `"text"` or `"checkbox"`.

{{ foreach $field in $wsComputopHosted.freeFields }}
  {{= $field.id }}: {{= $field.value }} ({{= $field.type }})
{{ /foreach }}

$wsComputopHosted.error

Returns an error message if a problem occurred during the payment. Evaluate it after the return to the payment page to tell the customer the reason.

{{ if $wsComputopHosted.error }}
  {{= $wsComputopHosted.error }}
{{ /if }}

$wsComputopHosted.paymentCanceled

Returns true if the customer canceled the payment. Use it to return to the payment selection after a cancellation.

{{ if $wsComputopHosted.paymentCanceled }}
  You canceled the payment.
{{ /if }}

$wsComputopHosted.paymentFailed

Returns true if the payment failed. In contrast to a cancellation, the customer attempted the payment, but it was not completed successfully.

{{ if $wsComputopHosted.paymentFailed }}
  The payment failed. Please try again.
{{ /if }}

Methods

No methods are available for $wsComputopHosted.

Actions

No actions are available for $wsComputopHosted.

Examples

Redirect to the Computop payment page

This example builds the complete redirect form: it points to action and stores the encrypted data and the merchant ID as hidden fields. On submission, the customer is taken to the Computop payment page.

<form method="post" action="{{= $wsComputopHosted.action }}">
  <input type="hidden" name="MerchantID" value="{{= $wsComputopHosted.merchantID }}">
  <input type="hidden" name="Len" value="{{= $wsComputopHosted.len }}">
  <input type="hidden" name="Data" value="{{= $wsComputopHosted.data }}">
  <button type="submit">Pay now</button>
</form>

Result
On submission, the customer is redirected to the Computop payment page.

Evaluate the payment result after the return

After Computop has redirected the customer back, check the result and display the appropriate message.

{{ if $wsComputopHosted.paymentCanceled }}
  You canceled the payment.
{{ elseif $wsComputopHosted.paymentFailed }}
  The payment failed.
  {{ if $wsComputopHosted.error }}
    Reason: {{= $wsComputopHosted.error }}
  {{ /if }}
{{ else }}
  Thank you for your payment.
{{ /if }}

Result
Depending on the outcome, the customer sees a cancellation, error, or success message.

Computop Hosted Payments (configuration) – sets up the Computop interface (merchant ID, keys, payment methods). A prerequisite for the module to be populated.
$wsCheckout – the checkout from which the redirect to the Computop payment page is initiated; provides the selected stored card via selectedPseudoCC.

Frontend

The basics

Getting started

Feature overview

Examples

Reference – Actions

Reference – Language

Reference – Modules

$wsComputopHosted - Computop (hosted payment page)

Basic concept

Pass encrypted data through unchanged

Module overview

Templates

Variables

$wsComputopHosted.action

$wsComputopHosted.data

$wsComputopHosted.len

$wsComputopHosted.encryptionType

$wsComputopHosted.merchantID

$wsComputopHosted.payType

$wsComputopHosted.language

$wsComputopHosted.template

$wsComputopHosted.hideSave

$wsComputopHosted.prefill

$wsComputopHosted.PCNr / PCNrBrand / PCNrYear / PCNrMonth / holder

$wsComputopHosted.freeFields

Properties of a free field

$wsComputopHosted.error

$wsComputopHosted.paymentCanceled

$wsComputopHosted.paymentFailed

Methods

Actions

Examples

Redirect to the Computop payment page

Evaluate the payment result after the return

​Basic concept

​Pass encrypted data through unchanged

​Module overview

​Templates

​Variables

​$wsComputopHosted.action

​$wsComputopHosted.data

​$wsComputopHosted.len

​$wsComputopHosted.encryptionType

​$wsComputopHosted.merchantID

​$wsComputopHosted.payType

​$wsComputopHosted.language

​$wsComputopHosted.template

​$wsComputopHosted.hideSave

​$wsComputopHosted.prefill

​$wsComputopHosted.PCNr / PCNrBrand / PCNrYear / PCNrMonth / holder

​$wsComputopHosted.freeFields

​Properties of a free field

​$wsComputopHosted.error

​$wsComputopHosted.paymentCanceled

​$wsComputopHosted.paymentFailed

​Methods

​Actions

​Examples

​Redirect to the Computop payment page

​Evaluate the payment result after the return

​Related links

Basic concept

Pass encrypted data through unchanged

Module overview

Templates

Variables

$wsComputopHosted.action

$wsComputopHosted.data

$wsComputopHosted.len

$wsComputopHosted.encryptionType

$wsComputopHosted.merchantID

$wsComputopHosted.payType

$wsComputopHosted.language

$wsComputopHosted.template

$wsComputopHosted.hideSave

$wsComputopHosted.prefill

$wsComputopHosted.PCNr / PCNrBrand / PCNrYear / PCNrMonth / holder

$wsComputopHosted.freeFields

Properties of a free field

$wsComputopHosted.error

$wsComputopHosted.paymentCanceled

$wsComputopHosted.paymentFailed

Methods

Actions

Examples

Redirect to the Computop payment page

Evaluate the payment result after the return

Related links