{"title":"Payment 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 the fields to be passed in an HPP payment request.<\/p>\n<\/colgroup>
Field<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n

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

\n

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

\n

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

\n

A comma-separated list of the allowed payment methods<\/a> to filter the payment method options that would normally be available through the skinned HPP.Only the listed payment methods are shown, if available; all other payment methods are ignored.Spaces are not allowed.If you do not include this optional parameter, the corresponding value in the\u00a0merchantSignature<\/code> computation is an empty string.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

A comma-separated list of the not allowed payment methods<\/a> to filter the payment method options that would normally be available through the skinned HPP.The listed payment methods are not made available on the HPP.Spaces are not allowed.If you do not include this optional parameter, the corresponding value in the\u00a0merchantSignature<\/code> computation is an empty string.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Defines the specific payment method used to process the payment.This field is required in a payment request call to\u00a0skipD<\/code> details.shtml<\/code> to skip the payment method selection.

The brandCode<\/code> values are case sensitive. For information on available brandCode<\/code> values, refer to Payment methods overview . <\/div><\/div><\/p>\n<\/td><\/tr>
\n

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

\n

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

\n

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

\n

The delay between the authorisation and scheduled auto capture, specified in hours.<\/p>\n<\/td><\/tr>

\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.This field may be required in a payment request call to Hosted Payment Pages API<\/code> to perform a directory lookup<\/a>.<\/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>.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Defines the specific issuer ID used to process the payment.This field is required for iDEAL payments.<\/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

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

\n

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

\n

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

\n

This field value is appended as-is to the return URL when the shopper completes, or abandons, the payment process and is redirected to your webshop.Typically, this field is used to hold and transmit a session ID.Maximum allowed character length: 128 characters.

If by including merchantReturnData<\/code> in a request causes it to exceed the allowed maximum size, the payment can fail.<\/div><\/div><\/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

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

\n

Class<\/p>\n<\/td>

\n

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

\n

Metadata consists of entries, each of which includes of key and value.Limitations: Error \"177\", \"Metadata size exceeds limit\"<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

An integer value that adds up to the normal fraud score.The value can be either a positive or negative integer.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

An HTML fragment containing the order details to display to the shopper on the payment review page, just before the shopper proceeds to the final order confirmation.Data is compressed and encoded in the session to prevent data corruption, for example in case the locale is set to non-Latin character sets.

  • Compression: GZIP<\/li>
  • Encoding: Base64<\/li><\/ul><\/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

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

\n

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

\n

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

\n

Defines the result URL<\/a>, i.e. the default result landing page shoppers are redirected to when they complete a payment on the HPP.We recommend setting a fixed\u00a0resultURL<\/code> in the skin configuration.However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the\u00a0resultURL<\/code> value specified in the skin configuration, you need to set the result URL for the payment session with the\u00a0resURL<\/code> parameter.<\/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

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

\n

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

\n

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

\n

The date within which the ordered goods or services need to be shipped or provided to the shopper.This field is also used to set the expiration date of an offline payment like boletos and 7 eleven.- Format:\u00a0ISO 8601<\/a>;\u00a0\u00a0YYYY-MM-DDThh:mm:ssTZD<\/a><\/p>\n

\n

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

\n

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

\n

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

\n

The shopper's email address.We recommend providing this information, because it is used in velocity fraud checks<\/a>.

\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

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

\n

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

\n

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

\n

A unique identifier for the shopper, for example, a customer ID.We recommend providing this information, as it is used in velocity fraud checks. It is also the key in recurring payments.This field is mandatory in recurring payments.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Set this field in your payment request if you want to include a variable shopper statement.You can include placeholders for the references. For example:

\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: