{"title":"Directory request","category":"default","creationDate":1776961627,"content":"
\n

Hosted Payment Pages are no longer available<\/strong><\/p>\n

To accept payments through an Adyen-hosted page, use our Hosted Checkout<\/a>.<\/p>\n

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.<\/p>\n<\/div><\/div>\n

This table lists parameters that should be passed to the\u00a0https:\/\/test.adyen.com\/hpp\/directory.shtml<\/a>\u00a0or\u00a0https:\/\/test.adyen.com\/hpp\/directory\/v2.shtml<\/a>\u00a0endpoint.<\/p>\n<\/colgroup>
Field<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n

countryCode<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

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.<\/p>\n

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\u00a0countryCode<\/code> parameter.The country<\/code> value format needs to adhere to the ISO 3166-1 alpha-2<\/a> standard.\u00a0An invalid country code results in a transaction\/request rejection.\u00a0You can look up country codes<\/a> on the ISO website.It is recommended that you provide the\u00a0countryCode<\/code>\u00a0field, to accurately state the actual location of the payment so that the correct payment methods for that location are retrieved.<\/p>\n<\/td><\/tr>

\n

currencyCode<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The three-character ISO currency code<\/a>.\u00a0<\/p>\n<\/td><\/tr>

\n

merchantAccount<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The merchant account identifier you want to process the (transaction) request with.<\/p>\n<\/td><\/tr>

\n

merchantReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

A reference to uniquely identify the payment.\u00a0This reference is used in all communication with you about the payment status.\u00a0We recommend using a unique value per payment; however, it is not a requirement.<\/p>\n

If you need to provide multiple references for a transaction, you can enter them in this field.\u00a0Separate each reference value with a hyphen character (\"-\").<\/p>\n

This field has a length restriction: you can enter max. 80 characters.<\/p>\n<\/td><\/tr>

\n

merchantSig<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

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<\/a>.<\/p>\n<\/td><\/tr>

\n

paymentAmount<\/code><\/p>\n<\/td>

\n

Int<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The payable amount that can be charged for the transaction, in minor units<\/a>.The transaction amount needs to be represented in minor units according to the Currency codes table<\/a>. Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
\nFor example, GBP\u00a010 is submitted as 1000<\/em>, whereas JPY\u00a010 is submitted as 10<\/em>.<\/p>\n<\/td><\/tr>

\n

sessionValidity<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

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:\u00a0ISO 8601<\/a>;\u00a0\u00a0YYYY-MM-DDThh:mm:ssTZD<\/a><\/p>\n

\n

shopperLocale<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n
locale = language code + country code<\/code><\/pre>\n<\/td><\/tr>
\n

skinCode<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

A unique code to identify the skin<\/a> you want to apply to the HPP in use to process the transaction.Note: