{"title":"Payment response","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\u00a0HPP payment response.<\/p>\n
Field<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n

additionalData.acquirerReference<\/code><\/p>\n<\/td>

\n

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

\n

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

\n

This field is returned for buy now, pay later payment methods in the result URL.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Returns the outcome of the payment. It can take one of the following values:

  • AUTHORISED<\/code>: The payment authorisation was successfully completed.<\/li>
  • REFUSED<\/code>: The payment was refused. Payment authorisation was unsuccessful.<\/li>
  • CANCELLED<\/code>: The payment was cancelled by the shopper before completion, or the shopper returned to the merchant's site before completing the transaction.<\/li>
  • PENDING<\/code>: It is not possible to obtain the final status of the payment.

    \nThis can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.<\/li>
  • ERROR<\/code>: An error occurred during the payment processing.<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

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

\n

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

\n

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

\n

The reference you assigned to the\u00a0original payment<\/a>.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

If you define this field in the\u00a0payment session setup<\/a>, the value is returned as is. This information is useful to build a custom result page, and it integrates seamlessly with the shopper's session on your server.When the payment status is defined, we send you a webhook event. This event is the recommended way to update the payment status in your back office. Webhooks are more reliable in its delivery because the\u00a0resultURL<\/code> parameter relies on the shopper's browser\/computer\/Internet connection, any of which could fail at any time.We recommend setting a fixed\u00a0resultURL<\/code>\u00a0in the skin configuration. However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the\u00a0resultURL<\/code>\u00a0value specified in the skin configuration, you need to set the result URL for the payment session with the resURL<\/code>\u00a0parameter.<\/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

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

\n

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

\n

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

\n

The payment method used in the transaction.When\u00a0authResult<\/code>\u00a0equals\u00a0CANCELLED<\/code>, the payment method may not be known \u2013 in this case, it is not included.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Adyen's 16-character unique reference associated with the transaction\/the request.\u00a0This value is globally unique; quote it when communicating with us about this request.When\u00a0authResult<\/code> equals PENDING<\/code>,\u00a0ERROR<\/code> or CANCELLED<\/code>, the\u00a0pspReference<\/code> may not yet be known; therefore, it may be empty or not included.<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n

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

\n

Only applicable for iDEAL payment method. <\/div><\/div>If a shopper cancels a payment, this field returns a random number.If the transaction results in an error, this field returns either of the possible following values:
  • authentication_error<\/li>
  • format_error<\/li>
  • invalid_field<\/li>
  • invalid_request<\/li>
  • invalid_amount<\/li>
  • system_failure<\/li>
  • unknown_account<\/li>
  • unknown_error<\/li>
  • unknown_id<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

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

\n

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

\n

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

\n

The shopperLocale<\/code> value provided in the\u00a0payment request<\/a>.

\n

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

\n

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

\n

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

\n

The code that identifies the\u00a0skin<\/a>\u00a0used to process the payment.<\/p>\n<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/online-payments\/classic-integrations\/hosted-payment-pages\/hosted-payment-pages-api\/hpp-payment-response-fields","articleFields":{"id":"25144477","type":"page","_expandable":{"operations":""},"status":"current","sitemap":{"priority":0.3},"parameters":{"anchor_new":"API Explorer<\/a>","parent_page":"classic Hosted Payment Pages (HPP)","new_desc":"integrating using our Checkout APIs"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/online-payments\/classic-integrations\/hosted-payment-pages\/hosted-payment-pages-api\/hpp-payment-response-fields","title":"Payment response","content":"\nHosted Payment Pages are no longer available\nTo accept payments through an Adyen-hosted page, use our Hosted Checkout.\nThis page is for the classic Hosted Payment Pages (HPP) integration, which has reached end-of-life. We are no longer processing transactions though HPP.\n\nThis table lists the fields to be passed in an\u00a0HPP payment response.\nFieldTypeRequiredDescription\nadditionalData.acquirerReference\n\nString\n\n\n\nThis field is returned for buy now, pay later payment methods in the result URL.\n\nauthResult\n\nString\n\n\n\nReturns the outcome of the payment. It can take one of the following values:AUTHORISED: The payment authorisation was successfully completed.REFUSED: The payment was refused. Payment authorisation was unsuccessful.CANCELLED: The payment was cancelled by the shopper before completion, or the shopper returned to the merchant's site before completing the transaction.PENDING: It is not possible to obtain the final status of the payment.\nThis can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.ERROR: An error occurred during the payment processing.\n\nmerchantReference\n\nString\n\n\n\nThe reference you assigned to the\u00a0original payment.\n\nmerchantReturnData\n\nString\n\n\n\nIf you define this field in the\u00a0payment session setup, the value is returned as is. This information is useful to build a custom result page, and it integrates seamlessly with the shopper's session on your server.When the payment status is defined, we send you a webhook event. This event is the recommended way to update the payment status in your back office. Webhooks are more reliable in its delivery because the\u00a0resultURL parameter relies on the shopper's browser\/computer\/Internet connection, any of which could fail at any time.We recommend setting a fixed\u00a0resultURL\u00a0in the skin configuration. However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the\u00a0resultURL\u00a0value specified in the skin configuration, you need to set the result URL for the payment session with the resURL\u00a0parameter.\n\nmerchantSig\n\nString\n\n\n\nThe 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.\n\npaymentMethod\n\nString\n\n\n\nThe payment method used in the transaction.When\u00a0authResult\u00a0equals\u00a0CANCELLED, the payment method may not be known \u2013 in this case, it is not included.\n\npspReference\n\nString\n\n\n\nAdyen's 16-character unique reference associated with the transaction\/the request.\u00a0This value is globally unique; quote it when communicating with us about this request.When\u00a0authResult equals PENDING,\u00a0ERROR or CANCELLED, the\u00a0pspReference may not yet be known; therefore, it may be empty or not included.\n\nreason\n\nString\n\n\n\n Only applicable for iDEAL payment method. If a shopper cancels a payment, this field returns a random number.If the transaction results in an error, this field returns either of the possible following values:authentication_errorformat_errorinvalid_fieldinvalid_requestinvalid_amountsystem_failureunknown_accountunknown_errorunknown_id\n\nshopperLocale\n\nString\n\n\n\nThe shopperLocale value provided in the\u00a0payment request. If no value is specified in the request, the default value en_GB is returned. \n\nskinCode\n\nString\n\n\n\nThe code that identifies the\u00a0skin\u00a0used to process the payment.\n","type":"page","locale":"pt","boost":15,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"Classic integrations for Ecommerce","lvl3":"Hosted Payment Pages","lvl4":"Reference for Hosted Payment Pages","lvl5":"Payment response"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/online-payments","lvl2":"https:\/\/docs.adyen.com\/pt\/online-payments\/classic-integrations","lvl3":"https:\/\/docs.adyen.com\/pt\/online-payments\/classic-integrations\/hosted-payment-pages","lvl4":"https:\/\/docs.adyen.com\/pt\/online-payments\/classic-integrations\/hosted-payment-pages\/hosted-payment-pages-api","lvl5":"\/pt\/online-payments\/classic-integrations\/hosted-payment-pages\/hosted-payment-pages-api\/hpp-payment-response-fields"},"levels":6,"category":"Online Payments","category_color":"green","tags":["Payment","response"]}}