Hosted Payment Page Options
You can customise the appearance of the Hosted Payment Page by sending additional fields in the request.
You can control which payment methods are displayed and the default or initial value to display in the input fields.
You can also state which fields you require to be mandatory, in which case the payment form may not be submitted until the Cardholder has complete all the mandatory fields. On the standard modal Hosted Payment Page, the mandatory requirement can also control whether the field needs to be displayed. A value of ‘Y’ or ‘N’ means the field must be displayed, ‘Y’ indicates that a value must be supplied, while ‘N’ indicates the value can be blank. Omitting the request field means that the field need not be displayed if the form can provide a better user experience without it. The Gateway may force some fields to be mandatory when the field is required by your Acquirer, regardless of any values provided in the request.
The modal Hosted Payment Page can also optionally provide the ability for a Cardholder to select card details previously stored in their Gateway Wallet and store new card details if required.
Not all fields and features may be supported if you have a customised Hosted Payment Page.
| Field Name | Mandatory? | Description |
|---|---|---|
| cardNumber | No[1] | Default value for the Card number field. |
| cardCVV | No[2] | Default value for the Card security number field. |
| cardExpiryMonth | No | Default value for the Card expiry month field. |
| cardExpiryYear | No | Default value for the Card expiry year field. |
| cardExpiryDate | No | Alternative to cardExpiryMonth/cardExpiryYear |
| customerName | No | Default value for the Cardholder’s name field. |
| customerAddress | No | Default value for the Cardholder’s address field. |
| customerTown | No | Default value for the Cardholder’s town field. |
| customerCounty | No | Default value for the Cardholder’s county field. |
| customerPostcode | No | Default value for the Cardholder’s postcode field. |
| customerCountryCode | No | Default value for the Cardholder’s country field. |
| customerEmail | No | Default value for the Cardholder’s email field. |
| customerPhone | No | Default value for the Cardholder’s phone number field. |
| receiverDateOfBirth | No | Default value for the Cardholder’s date of birth field. |
| cardCVVMandatory | No [4] | Card security number field requirements (Y or N). |
| customerNameMandatory | No | Cardholder’s name field requirements (Y or N). |
| customerFullNameMandatory | No[3] | Cardholder’s name field requirements (Y or N). |
| customerAddressMandatory | No | Cardholder’s address field requirements (Y or N). |
| customerTownMandatory | No | Cardholder’s town field requirements (Y or N). |
| customerCountyMandatory | No | Cardholder’s county field requirements (Y or N). |
| customerPostcodeMandatory | No | Cardholder’s postcode field requirements (Y or N). |
| customerCountryCodeMandatory | No | Cardholder’s country field requirements (Y or N). |
| customerEmailMandatory | No | Cardholder’s email field requirements (Y or N). |
| customerPhoneMandatory | No | Cardholder’s phone field requirements (Y or N). |
| receiverDateOfBirthMandatory | No | Cardholder’s date of birth requirements (Y or N). |
| walletID | No | Identifier for a Gateway Wallet to use when loading, displaying and saving card and address details. |
| cardID | No | Identifier for an existing card stored in a Wallet whose details should be initially shown on the form. The card number will be shown masked. Use a value of -1 and provide a walletID to select the default card for that Wallet. |
| cardToken | No | Identifier for an existing card stored in a Wallet whose details should be initially shown on the form. The card number will be shown masked. |
| customerAddressID | No | Identifier for an existing address stored in a Wallet whose details should be initially shown on the form. Use a value of -1 and provide a walletID to select the default address for that Wallet. |
| formRedirectDelay | No | Delay in seconds to wait before the Hosted Payment Page redirects back to the Merchant on completion of the transaction. The value must be between -1 and 300 otherwise a default of 5 will be used. A value of -1 causes no automatic redirection to be performed. A value of 0 will cause immediate redirection. |
| formAmountEditable | No | Enables the payment amount to be edited by the consumer thus allowing the consumer to choose the amount they wish to pay. |
| formResponsive | No | Request the Hosted Payment Page adjust its layout according to the browser display size etc (Y or N). |
| formCancelRequired | No | Request the Hosted Payment Page show a cancel button to allow the payment to be cancelled resulting in a transaction responseCode of 65576 (REQUEST CANCELLED). |
| formWalletRequired | No | Request the Hosted Payment Page allow the cards in a Gateway Wallet to be displayed, and selected from, if a walletID is provided. |
| formSaveCardRequired | No | Request the Hosted Payment Page allow the cards in a Gateway Wallet to be displayed, and selected from, if a walletID is provided (Y or N). Note: this field defaults to Y. |
| WalletRequired | No | Deprecated name for formSaveCardRequired. |
| paymentMethod | No | Request the Hosted Payment Page invoke an alternative payment method on display without the need for the Customer to select it. |
| allowedPaymentMethods | No | Comma separated list of paymentMethods supported by the Merchant to show on Hosted Payment Page where supported. |
[4] Not supported by the Hosted Integration. Not all Acquirers will accept CITs without a CVV.