Payment response

This table lists the fields to be passed in an HPP payment response.

Field
Type
Required
Description
additionalData.acquirerReference String (error)

This field is returned for open invoice in the result URL.

authResult String (tick)

Returns 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.
    This 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.
merchantReference String (tick) The reference you assigned to the original payment.

merchantReturnData

String (error)

If you define this field in the payment 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 server-to-server notification. This notification is the recommended way to update the payment status in your back office. The notification system is more reliable in its delivery because the resultURL parameter relies on the shopper's browser/computer/Internet connection, any of which could fail at any time.

We recommend setting a fixed resultURL in the skin configuration. However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the resultURL value specified in the skin configuration, you need to set the result URL for the payment session with the resURL parameter.

merchantSig

String (tick)

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.

paymentMethod String (error)

The payment method used in the transaction.

When authResult equals CANCELLED, the payment method may not be known – in this case, it is not included.

pspReference String (error)
Adyen's 16-character unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request.

When authResult equals PENDINGERROR or CANCELLED, the pspReference may not yet be known; therefore, it may be empty or not included.

reason String (error)
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_error
  • format_error
  • invalid_field
  • invalid_request
  • invalid_amount
  • system_failure
  • unknown_account
  • unknown_error
  • unknown_id
shopperLocale String (tick)

The shopperLocale value provided in the payment request.

If no value is specified in the request, the default value en_GB is returned.
skinCode String (tick) The code that identifies the skin used to process the payment.