To communicate with the Adyen API you should submit HTTP POST requests to corresponding endpoints. These endpoints differ for test and live accounts.
This document lists all endpoints available for you to integrate with the Adyen payments platform and run QA checks.
Endpoints
This is an overview of the test and live URL endpoints to communicate with our Hosted Payment Pages (HPP) solution.
Test | Live |
---|---|
https://test.adyen.com/hpp/select.shtml |
https://live.adyen.com/hpp/select.shtml |
https://test.adyen.com/hpp/pay.shtml |
https://live.adyen.com/hpp/pay.shtml |
This is an overview of the test and live URL endpoints to communicate with our Directory Lookup (DL) solution.
Test | Live |
---|---|
https://test.adyen.com/hpp/directory.shtml |
https://live.adyen.com/hpp/directory.shtml |
https://test.adyen.com/hpp/directory/v2.shtml | https://live.adyen.com/hpp/directory/v2.shtml |
https://test.adyen.com/hpp/skipDetails.shtml |
https://live.adyen.com/hpp/skipDetails.shtml |
Payment request
This table lists the fields to be passed in an HPP payment request.
Field | Type | Required | Description | |
---|---|---|---|---|
allowedMethods |
String |
|
A comma-separated list of the allowed payment methods 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
merchantSignature computation is an empty string.
|
|
blockedMethods |
String |
|
A comma-separated list of the not allowed payment methods 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
merchantSignature computation is an empty string.
|
|
brandCode |
String |
Defines the specific payment method used to process the payment. This field is required in a payment request call to
The
brandCode values are case sensitive. For information on available
brandCode
values, refer to
Payment methods overview
.
|
||
captureDelayHours |
Int | ![]() |
The delay between the authorisation and scheduled auto capture, specified in hours. | |
countryCode |
String |
|
By default, the payment methods offered to a shopper are filtered based on the country the shopper's IP address is mapped to. In this way, shoppers are not offered payment methods that are not available in the country they are carrying out the transaction from. 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
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 web site.
This field may be required in a payment request call to |
|
currencyCode |
String |
![]() |
||
issuerId |
String | Defines the specific issuer ID used to process the payment. This field is required for iDEAL payments. |
||
merchantAccount |
String |
![]() |
The merchant account identifier you want to process the (transaction) request with. |
|
merchantReference |
String | ![]() |
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. |
|
merchantReturnData |
String |
|
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 web shop. Typically, this field is used to hold and transmit a session ID. Maximum allowed character length: 128 characters. If by including |
|
merchantSig |
String |
![]() |
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.
|
|
metadata |
Class | Metadata consists of entries, each of which includes of key and value. Limitations: Error "177", "Metadata size exceeds limit" |
||
Key |
String | ![]() |
Key for the information to be provided. Example: key = 'storeCountry' Limitations: Error "178", "Metadata key size exceeds limit" |
|
value |
String | ![]() |
Information value. Example: value = 'US' Limitations: Maximum length: 80 characters, the value is truncated to 80 characters with '...' appended to it. |
|
offset |
Int | ![]() |
An integer value that adds up to the normal fraud score. The value can be either a positive or negative integer. |
|
orderData |
String | 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.
|
||
paymentAmount |
Int |
![]() |
The payable amount that can be charged for the transaction, in minor units.
The transaction amount needs to be represented in minor units according to the
Currency codes table. Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
For example, 10 GBP is submitted as 1000, whereas 10 JPY is submitted as 10.
|
|
resURL |
String | Defines the result URL, i.e. the default result landing page shoppers are redirected to when they complete a payment on the HPP. We recommend setting a fixed However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the |
||
sessionValidity |
String |
|
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.
|
|
shipBeforeDate |
String | ![]() |
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.
|
|
shopperEmail |
String |
|
The shopper's email address. We recommend providing this information, as it is used in velocity fraud checks. Depending on your integration this field may be mandatory for you, check with the Support Team. |
|
shopperLocale |
String | ![]() |
locale = language code + country code It specifies the language to use during the transaction. For example: When it is not necessary to include the country-specific part, use only the language code. For example: If not specified, the locale preference is set to |
|
shopperReference |
String | ![]() |
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. |
|
shopperStatement |
String | ![]() |
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:
Note:
|
|
skinCode |
String |
A unique code to identify the skin you want to apply to the HPP in use to process the transaction. Note:
|
Payment response
This table lists the fields to be passed in an HPP payment response.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
additionalData.acquirerReference |
String | ![]() |
This field is returned for open invoice in the result URL. |
authResult |
String | ![]() |
Returns the outcome of the payment. It can take one of the following values:
|
merchantReference |
String | ![]() |
The reference you assigned to the original payment. |
|
String | ![]() |
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 We recommend setting a fixed |
|
String | ![]() |
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 | ![]() |
The payment method used in the transaction. When |
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.
When |
reason |
String | ![]() |
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:
|
shopperLocale |
String | ![]() |
The
If no value is specified in the request, the default value
en_GB
is returned.
|
skinCode |
String | ![]() |
The code that identifies the skin used to process the payment. |
Recurring details request
This table lists data that should be passed in an HPP payment request to create a recurring contract.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
recurringContract |
String | ![]() |
The type of recurring contract to be used. Possible values:
|
shopperEmail |
String | ![]() |
The shopper's email address. |
shopperReference |
String | ![]() |
The shopper's reference for the payment transaction. |
Directory request
This table lists parameters that should be passed to the https://test.adyen.com/hpp/directory.shtml or https://test.adyen.com/hpp/directory/v2.shtml endpoint.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
countryCode |
String | ![]() |
By default, the payment methods offered to a shopper are filtered based on the country the shopper's IP address is mapped to. In this way, shoppers are not offered payment methods that are not available in the country they are carrying out the transaction from. 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
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 web site.
It is recommended that you provide the |
currencyCode |
String | ![]() |
|
merchantAccount |
String | ![]() |
The merchant account identifier you want to process the (transaction) request with. |
merchantReference |
String | ![]() |
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.
|
merchantSig |
String | ![]() |
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.
|
paymentAmount |
Int | ![]() |
The payable amount that can be charged for the transaction, in minor units.
The transaction amount needs to be represented in minor units according to the
Currency codes table. Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
For example, 10 GBP is submitted as 1000, whereas 10 JPY is submitted as 10.
|
sessionValidity |
String | ![]() |
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.
|
shopperLocale |
String | ![]() |
locale = language code + country code Specifies the language to use during the transaction. For example: When it is not necessary to include the country-specific part, use only the language code. For example: If not specified, the locale preference is set to |
skinCode |
String | ![]() |
A unique code to identify the skin you want to apply to the HPP in use to process the transaction. Note:
|
Directory response
This table lists fields returned in a response to the https://test.adyen.com/hpp/directory.shtml and https://test.adyen.com/hpp/directory/v2.shtml calls.
Field | Type | Required | Description | ||
---|---|---|---|---|---|
paymentMethods |
Array | ![]() |
Contains the information about the available payment methods. |
||
brandCode |
String | ![]() |
Code of the payment method brand. |
||
issuers |
Array | Returned only in case of bank payments. |
|||
issuerId |
String | ![]() |
ID of the issuer. | ||
name |
String | ![]() |
Name of the issuer. | ||
logos |
Object | ![]() |
NEW IN V2 The payment method's logo of different sizes. |
||
normal |
String | ![]() |
The URL pointing to the payment method logo of the normal size. | ||
small |
String | ![]() |
The URL pointing to the payment method logo of the small size. | ||
tiny |
String | ![]() |
The URL pointing to the payment method logo of the tiny size. | ||
name |
String | ![]() |
Name of the payment method. |
SkipDetails request
This table lists parameters that should be passed to the https://test.adyen.com/hpp/skipDetails.shtml endpoint.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
allowedMethods |
String | ![]() |
A comma-separated list of the allowed payment methods 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
merchantSignature computation is an empty string.
|
blockedMethods |
String | ![]() |
A comma-separated list of the not allowed payment methods 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
merchantSignature computation is an empty string.
|
brandCode |
String | ![]() |
Defines the specific payment method used to process the payment. This field is required in a payment request call to The |
countryCode |
String | ![]() |
By default, the payment methods offered to a shopper are filtered based on the country the shopper's IP address is mapped to. In this way, shoppers are not offered payment methods that are not available in the country they are carrying out the transaction from. 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
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 web site.
This field may be required in a payment request call to directory.shtml to perform a directory lookup. |
currencyCode |
String | ![]() |
The three-character
ISO currency code.
|
issuerId |
String | ![]() |
Defines the specific issuer ID used to process the payment. This field is required in a payment request call to |
merchantAccount |
String | ![]() |
The merchant account identifier you want to process the (transaction) request with. |
merchantReference |
String | ![]() |
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. |
merchantReturnData |
String | ![]() |
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 web shop. Typically, this field is used to hold and transmit a session ID. Maximum allowed character length: 128 characters. If by including |
merchantSig |
String | ![]() |
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.
|
offset |
Int | ![]() |
An integer value that adds up to the normal fraud score. The value can be either a positive or negative integer. |
orderData |
String | ![]() |
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.
|
paymentAmount |
Int |
![]() |
The payable amount that can be charged for the transaction, in minor units.
The transaction amount needs to be represented in minor units according to the
Currency codes table. Some currencies do not have decimal points, such as JPY, and some have 3 decimal points, such as BHD.
For example, 10 GBP is submitted as 1000, whereas 10 JPY is submitted as 10.
|
resURL |
String | ![]() |
Defines the result URL, i.e. the default result landing page shoppers are redirected to when they complete a payment on the HPP. We recommend setting a fixed However, sometimes it may be preferable to set the result URL on a per-payment basis: to override the |
sessionValidity |
String | ![]() |
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.
|
shipBeforeDate |
String | ![]() |
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, oxxo and 7 eleven.
|
shopperEmail |
String | ![]() |
The shopper's email address. We recommend providing this information, as it is used in velocity fraud checks. Depending on your integration this field may be mandatory for you, check with the Support Team. |
shopperLocale |
String | ![]() |
locale = language code + country code It specifies the language to use during the transaction. For example: When it is not necessary to include the country-specific part, use only the language code. For example: If not specified, the locale preference is set to |
shopperReference |
String | ![]() |
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. |
shopperStatement |
String | ![]() |
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:
Note:
|
skinCode |
String | ![]() |
A unique code to identify the skin you want to apply to the HPP in use to process the transaction. Note:
|
SkipDetails response
This table lists fields returned in a response to the https://test.adyen.com/hpp/skipDetails.shtml call.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
additionalData.acquirerReference |
String | ![]() |
This field is returned for open invoice in the result URL. |
authResult |
String | ![]() |
Returns the outcome of the payment. It can take one of the following values:
|
merchantReference |
String | ![]() |
The reference you assigned to the original payment. |
|
String | ![]() |
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 We recommend setting a fixed |
|
String | ![]() |
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 | ![]() |
The payment method used in the transaction. When |
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. When |
shopperLocale |
String | ![]() |
The
If no value is specified in the request, the default value
en_GB
is returned.
|
skinCode |
String | ![]() |
The code that identifies the skin used to process the payment. |
HPP additional fields
ACH payment fields
Initiate a payment request with the given fields:
Field | Type | Required | Description | |
---|---|---|---|---|
bankAccount |
Object | ![]() |
A container for bank account data. It contains the following elements:
|
|
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 |
|
ownerName |
String | ![]() |
The bank account holder name. | |
billingAddress |
Object | ![]() |
A container for the billing address information. It contains the following elements:
|
|
city |
String | ![]() |
Name of the city. |
|
country |
String | ![]() |
The country identifier. For ACH payments, set its value to |
|
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. You can append a house number to the |
An ACH payment response is similar to card payment responses, the only difference being that an ACH response does not include an authorisation code (authCode
), because it is not generated in this case.
The table below lists parameters returned in an ACH payment response.
Field | Type | Required | Description | |
---|---|---|---|---|
additionalData |
Object | ![]() |
The
additionalData object is a generic container that can hold extra fields.
|
|
achdirectdebit.dateOfSignature |
String | ![]() |
Transaction signature date. Format: yyyy-MM-dd |
|
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:
|
|
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:
|
Billing address and AVS fields
For more information on Address Verification System (AVS), refer to AVS.
You can choose to have the HPPs collect the billing address and/or pre-populate these values from your own system.
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
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 web site.
|
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 The The
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 The billing address details are stored with the transaction. They are visible in the Customer Area when either a |
Risk fields
Adyen's API for payment requests contains several optional fields that can be provided by the merchants. Some of these fields are quite important when the merchant uses several risk checks in the Risk System. We recommend the use of the following fields in order to use to its fullest the capabilities of Adyen's Risk system.
Field
|
Required
|
Description
|
---|---|---|
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: |
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: |
deliveryAddressType |
![]() |
Specifies whether the shopper is allowed to view and/or modify delivery address fields. It can have the following values:
If the field is supplied, the |
deliveryDate |
![]() |
The expected date of delivery or fulfillment of the goods/services to the shopper. Used in the following risk checks: |
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: |
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.externalRiskScore |
![]() |
Used only before authorisation and when external risk provider is used by merchant. Used in External Risk Score Check. |
riskdata.shopperAccountCreationDate |
![]() |
This specifies the date when the shopper's account was created. Format: Used in Shopper Account Age check. |
shopper |
![]() |
Shopper personal information that includes shopper name, date of birth, and so on (only in countries where it is legal to collect). For more information, refer to Shopper information fields. Used in the following risk checks: |
|
![]() |
The shopper's email address. We recommend providing this information, as 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: |
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: |
Shopper fields
Shopper details can be sent to Adyen. They can also be encrypted using a signature. These are the fields Adyen recognizes as shopper information:
Field
|
Type
|
Required
|
Description
|
---|---|---|---|
shopper.dateOfBirthDayOfMonth |
String | ![]() |
The day of the month of the shopper's birth. |
shopper.dateOfBirthMonth |
String | ![]() |
The month of the shopper's birth. |
shopper.dateOfBirthYear |
String | ![]() |
The year of the shopper's birth. |
shopper.firstName |
String | ![]() |
The shopper's first name. |
shopper.gender |
String | ![]() |
The shopper's gender. |
shopper.infix |
String | ![]() |
The shopper infix. |
shopper.lastName |
String | ![]() |
The shopper's last name. |
shopper.telephoneNumber |
String | ![]() |
The shopper's telephone number. This field is mandatory in case of SecurePlus authorise requests. |
shopperType |
String | ![]() |
This field can be used if validation of the shopper fields is desired. Possible values:
|
HPP L2/L3 data


Field | Type | Level 2 | Level 3 | Max. length | Description | |
---|---|---|---|---|---|---|
enhancedSchemeData |
||||||
customerReference |
String | ![]() |
![]() |
25 |
Customer code, if supplied by a customer. Encoding: ASCII. |
|
totalTaxAmount |
Numeric | ![]() |
![]() |
12 | Total tax amount, in minor units. For example, 2000 means USD 20.00 |
|
freightAmount |
Numeric | ![]() |
![]() |
12 | Shipping amount, in minor units. For example, 2000 means USD 20.00 |
|
dutyAmount |
Numeric | ![]() |
![]() |
12 | Duty amount, in minor units. For example, 2000 means USD 20.00 |
|
destinationPostalCode |
String | ![]() |
![]() |
10 |
The postal code of a destination address. Encoding: ASCII. Required for American Express. |
|
destinationStateProvinceCode |
String | ![]() |
![]() |
3 |
Destination state or province code. Encoding: ASCII. |
|
shipFromPostalCode |
String | ![]() |
![]() |
10 |
The postal code of a "ship-from" address. Encoding: ASCII. |
|
destinationCountryCode |
String | ![]() |
![]() |
3 |
Destination country code. Encoding: ASCII. |
|
orderDate |
String | ![]() |
![]() |
6 |
Order date. Format: ddMMyy Encoding: ASCII. |
|
You can submit a maximum of 9 line items. |
||||||
commodityCode |
String | ![]() |
![]() |
12 |
Item commodity code. Encoding: ASCII. |
|
description |
String | ![]() |
![]() |
26 |
Item description. Encoding: ASCII. |
|
productCode |
String | ![]() |
![]() |
12 |
Product code. Encoding: ASCII. |
|
quantity |
Numeric | ![]() |
![]() |
12 |
Quantity, specified as an integer value. Value must be greater than 0. |
|
unitOfMeasure |
![]() |
![]() |
3 |
Item unit of measurement. Encoding: ASCII. |
||
unitPrice |
Numeric | ![]() |
![]() |
12 | Unit price, specified in minor units. | |
discountAmount |
Numeric | ![]() |
![]() |
12 | Discount amount, in minor units. For example, 2000 means USD 20.00 |
|
totalAmount |
Numeric | ![]() |
![]() |
12 | Total amount, in minor units. For example, 2000 means USD 20.00 |