HPP additional fields

bankAccountNumber

String

The US bank account number from which the payment will be debited.Format: numeric.For ACH transactions, the bank account number needs to comply with length restrictions: min. 4, max. 17 digits.

bankLocationId

String

The ABA routing transit number for ACH payments from the bank account.Format: 9-digit number.Do not remove any leading zeroes in it.

bankName

String

The name of the bank where the account is held.

bic

String

The business identifier code (BIC) is the SWIFT address assigned to a bank.

countryCode

String

The country code for the transaction.For ACH transactions, set its value to US.

ownerName

String

The bank account holder name.

city

String

Name of the city.

country

String

The country/region identifier.For ACH payments, set its value to US.

houseNumberOrName

String

House number, or house name, or another house identifier.

postalCode

String

Zip/Post code.

stateOrProvince

String

Name of the state, region or province, where applicable.

street

String

Name of the street.

pspReference

String

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.

refusalReason

String

When the payment is not authorised and it is refused, this field holds Adyen's mapped reason for the refusal.

resultCode

String

The outcome of the payment. The possible values are:

• Authorised
• Received
• Refused

achdirectdebit.dateOfSignature

String

achdirectdebit.mandateId

String

Its value corresponds to the pspReference value for the transaction.

achdirectdebit.sequenceType

String

achdirectdebit.sequenceType can take one of the following values:

• Final: (FNAL) Last/final collection in a series of direct debit instructions.
• First: (FRST) Initial/first collection in a series of direct debit instructions.
• OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.
• Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.

billingAddress.city

String

The city.

billingAddress.country

String

The country code information of the billing address section.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. 

billingAddress.houseNumberOrName

String

The house number (or name).

billingAddress.postalCode

String

The postal/zip code.

billingAddress.stateOrProvince

String

The state or province.

billingAddress.street

String

The street name.

billingAddressType

String

You can specify the billingAddressType to define whether the shopper is allowed to view and/or modify these personal details.The billingAddressType field is part of the merchantSignature, which is used to calculate the HMAC.The billingAddressType can be:

• Not supplied - modifiable / visible
• 1 - unmodifiable / visible
• 2 - unmodifiable / invisible

If you want the shopper to enter the billing address on the payment pages, you need to select the Billing Address Fields (AVS) checkbox on the skin edit page in the Customer Area, without supplying a billingAddressType value. 

The billing address details are stored with the transaction. They are visible in the Customer Area when either a billingAddressType value is provided, or when Billing Address Fields (AVS) is configured for a skin.

billingAddress

The address where the shopper is going to receive the bill. Providing the following detailed information street, houseNumberOrName, city, postalCode, stateOrProvince, country.Used in the following risk checks:

• Billing address does not match cardholder address (AVS)

browserInfo

With the browser info data, we can determine if the device is mobile or not, which is used for device fingerprinting and other device logic.

deliveryAddress

The address where the shopper is going to receive goods/services. Providing the following detailed information street, houseNumberOrName, city, postalCode, stateOrProvince, country.Used in the following risk checks:

• Billing Address differs from Delivery Address

deliveryAddressType

Specifies whether the shopper is allowed to view and/or modify delivery address fields.It can have the following values:

• 1: the delivery address fields are visible but unmodifiable.

deliveryDate

The expected date of delivery or fulfillment of the goods/services to the shopper.Used in the following risk checks:

• Time To Delivery Check

dfValue

Information from the shopper's device and uses the combined value to identify the device of the shopper.Used in the following risk checks:

• Shopper initiated a transaction more than X times within a time period

merchantOrderReference

A reference that merchants can use to link multiple transactions to each other.

merchantReference

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.

offset

An integer value that adds up to the normal fraud score.The value can be either a positive or negative integer.

riskdata.deliveryMethod

The method to deliver the goods to the shopper.Used in Delivery Method Check.

riskdata.shopperAccountCreationDate

This specifies the date when the shopper's account was created.Format: yyyy-MM-dd HH:mm:ss.sssZThis field can only be used in HPP integrations, and is only used when you have selected the creation date option in the Shopper Account Age check.

shopper

Shopper personal information that includes shopper name, date of birth, and so on (only in countries/regions where it is legal to collect). For more information, refer to Shopper information fields.Used in the following risk checks:

• Shopper Name referral list

shopperEmail

The shopper's email address.We recommend providing this information, because it is used in velocity fraud checks.Depending on your integration this field may be mandatory for you, check with the Support Team.It is not advisable to use a hard-coded email address.Used in the following risk checks:

• Multiple distinct Email addresses used by Shopper

shopperReference

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.Used in the following risk checks:

• Multiple distinct Shopper References used by Shopper

The shopper infix.

The shopper's telephone number.

This field is mandatory in case of SecurePlus authorise requests.

This field can be used if validation of the shopper fields is desired.

Possible values: 

• 1 - unmodifiable / visible
• 2 - unmodifiable / invisible

Customer code, if supplied by a customer.

Encoding: ASCII.

Total tax amount, in minor units.

For example, 2000 means USD 20.00

Shipping amount, in minor units.

For example, 2000 means USD 20.00

Duty amount, in minor units.

For example, 2000 means USD 20.00

The postal code of a destination address.

Encoding: ASCII.

Destination state or province code.

Encoding: ASCII.

The postal code of a "ship-from" address.

Encoding: ASCII.

Destination country code.

Encoding: ASCII.

Order date.

Format: ddMMyy

Encoding: ASCII.

Item commodity code.

Encoding: ASCII.

Item description.

Encoding: ASCII.

Product code.

Encoding: ASCII.

Quantity, specified as an integer value.

Item unit of measurement.

Encoding: ASCII.

Discount amount, in minor units.

For example, 2000 means USD 20.00

Total amount, in minor units.

For example, 2000 means USD 20.00