Classic-integration icon

Directory request

Hosted Payment Pages are no longer available

To accept payments through an Adyen-hosted page, use our Hosted Checkout.

This page is for the classic Hosted Payment Pages (HPP) integration, which has reached end-of-life. We are no longer processing transactions though HPP.

This table lists parameters that should be passed to the https://test.adyen.com/hpp/directory.shtml or https://test.adyen.com/hpp/directory/v2.shtml endpoint.

FieldTypeRequiredDescription

countryCode

String

-x-

By default, the payment methods offered to a shopper are filtered based on the location the shopper's IP address is mapped to. In this way, shoppers are not offered payment methods that are not available in the country/region they are carrying out the transaction from.

This IP-to-country mapping is not 100% accurate, so if you have already established the country of the shopper, you can set it explicitly in the countryCode parameter.The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO website.It is recommended that you provide the countryCode field, to accurately state the actual location of the payment so that the correct payment methods for that location are retrieved.

currencyCode

String

-white_check_mark-

The three-character ISO currency code

merchantAccount

String

-white_check_mark-

The merchant account identifier you want to process the (transaction) request with.

merchantReference

String

-white_check_mark-

A reference to uniquely identify the payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

If you need to provide multiple references for a transaction, you can enter them in this field. Separate each reference value with a hyphen character ("-").

This field has a length restriction: you can enter max. 80 characters.

merchantSig

String

-white_check_mark-

The signature in Base64 encoded format. It is generated by concatenating the values of payment session fields, and by computing the HMAC using the shared secret, as configured in the skin.
For more information, refer to HMAC signature calculation.

paymentAmount

Int

-white_check_mark-

The payable amount that can be charged for the transaction, in minor units.The transaction amount needs to be represented in minor units according to the Currency codes table. Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
For example, GBP 10 is submitted as 1000, whereas JPY 10 is submitted as 10.

sessionValidity

String

-white_check_mark-

The payment deadline; the payment needs to occur within the specified time value.This is especially useful for tickets and reservations, where you want to hold items for sale for a short, limited period of time.- Format: ISO 8601;  YYYY-MM-DDThh:mm:ssTZD

  • Example: 2017-07-17T13:42:40+01:00

shopperLocale

String

-x-

locale = language code + country code

skinCode

String

-white_check_mark-

A unique code to identify the skin you want to apply to the HPP in use to process the transaction.Note:

  • You can skin your hosted payment page to make it consistent with your brand look and feel.
  • You can create multiple skins in your merchant account to provide tailored branding experiences to your shoppers.