Payment request fields

Name Type Required Description
merchantAccount String (tick)
The merchant account identifier you want to process the (transaction) request with.
amount String (tick)
A container object for the payable amount information for the transaction.

It contains the following elements:

  • currency
  • value
currency String (tick)
The three-character ISO currency code.
value int (tick)

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.

reference
String (tick)
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.

shopperIP String (error)

The shopper's IP address.

We recommend you provide this data, as it is used in a number of risk checks. For example: number of payment attempts, location based checks.

shopperEmail String (error)

The shopper's email address.

We recommend you provide this data, as it is used in velocity fraud checks.

shopperReference String (error)

The shopper's reference for the payment transaction.

We recommend you provide this data.

This field is required for recurring payments.

fraudOffset int (error)

An integer value that is added to the normal fraud score. The value can be either positive or negative.

selectedBrand String (error)

Some payment methods require defining a value for this field to specify how to process the transaction.

For the MisterCash payment method, it can be set to:

  • maestro (default), to be processed like a Maestro card, or
  • bcmc, to be processed like a MisterCash card.
deliveryDate Date (error) This specifies the date and time the goods of the order would be delivered, in ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ

 

merchantOrderReference String (error)

This reference allows to link multiple transactions to each other.

shopperInteraction

  (error)

Specifies the following information:

  • The sales channel the shopper gives their card details through;
  • Whether the shopper is a returning customer.

By default, for the web service API Adyen assumes Ecommerce shopper interaction.

This field has the following possible values:

  • Ecommerce - Online transactions where the card holder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
  • ContAuth - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
  • POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
  • Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
metadata Class (error)

Metadata consists of entries, each of which include of key and value.

This field takes the following children:

  • Key
  • Value

Limitations:

  • Error "177", "Metadata size exceeds limit"

key

String (error)

Key for the information to be provided. Example: key = 'storeCountry'

Limitations:

Error "178", "Metadata key size exceeds limit"

value String (error)

Information value. Example: value = 'US'

Limitations:

Maximum length: 80 characters, value is truncated to 80 characters with '...' appended to it.

additionalData fields

Name Type Required Description
riskdata.deliveryMethod String (error) This specifies the method of delivery for the goods.
retry.chainAttemptNumber Integer (error)

The number of times the transaction (not order) has been retried. For instance, the chainAttemptNumber set to 2 means that this transaction has been already retried on another provider before being sent to Adyen.

Make sure that you also provide the merchantOrderReference field value when specifying the chainAttemptNumber.

retry.orderAttemptNumber Integer (error)

The index of the attempt to bill a particular order, which is identified by the merchantOrderReference field.

Make sure that you also provide the merchantOrderReference field value when specifying the orderAttemptNumber.

retry.skipRetry Boolean (error)

The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.

Make sure that you also provide the merchantOrderReference field value when specifying the skipRetry.