Common API

This section contains information on basic objects that are used throughout the Adyen API to hold common information in a structured way. To learn more on endpoints and data objects used in specific API calls, refer to corresponding topics in this documentation.

Types in this section:

Type Description
Address

This object contains detailed information on a physical address.

Amount

This object provides fields to hold information on the funds amount.

BrowserInfo

This object provides fields to hold information on the user browser.

Installments

A container for the installment information.

Name

This object provides the fields to hold structured information on a person's name and gender.

ServiceException

When the API request is rejected, the response message contains the following fields.

Address

This object contains detailed information on a physical address.

Field Type Required Description
city String (tick) The city name.
country String (tick) A valid value is an ISO 2-character country code.
houseNumberOrName String (tick)

The house number or name.

postalCode String (error) The postal code with a maximum of 5 characters for USA and maximum of 10 characters for any other country.
stateOrProvince String (error)

For USA or Canada, a valid 2-character abbreviation for the state or province respectively. For other countries any abbreviation with maximum 3 characters for the state or province.

street String (tick)

The street name.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

Amount

This object provides fields to hold information on the funds amount.

Field Type Required Description
currency String (tick) The three-character ISO currency code.
value Int (tick)

The payable amount that can be charged for the transaction.

The transaction amount needs to be represented in minor units according to the following table.

BrowserInfo

This object provides fields to hold information on the user browser.

Field Type Required Description
acceptHeader String (tick) The accept header value of the shopper's browser.
colorDepth Integer (error) The color depth of the shopper's device in bits per pixel. Should be obtained by using the browser's screen.colorDepth property.
javaEnabled Boolean (error) Boolean value indicating if the shopper's browser is able to execute Java.
language String (error) The navigator.language value of the shopper's browser (as defined in IETF BCP 47).
screenHeight Integer (error)

The total height of the shopper's device screen in pixels.

screenWidth Integer (error)

The total width of the shopper's device screen in pixels.

timeZoneOffset Integer (error) Time difference between UTC time and the shopper's browser local time, in minutes.
userAgent String (tick) The user agent value of the shopper's browser.

Installments

A container for the installment information.

Field Type Required Description
value int (short) (tick)

Defines the number of installments. Its value needs to be greater than zero.

Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.

Name

This object provides the fields to hold structured information on a person's name and gender.

Field Type Required Description
firstName String (tick) A person's first name.
gender Enum (tick)

This enumeration accepts the following values:

  • MALE
  • FEMALE
  • UNKNOWN
infix String (error)

A person name's infix, if applicable.

  • Max. length: 20 characters
lastName String (tick) A person's last name.

PaymentMethodVariant

The paymentMethodVariant field returns the type of payment method used during a transaction.

In addition to the values listed below, Adyen can return other payment method variants depending on your configuration.

Mastercard

Payment Method Variant/Card type Description
mc Mastercard card (not classified)
mcdebit Mastercard debit card (not classified)
mccredit Mastercard credit card (not classified)
mcstandardcredit Mastercard standard credit card
mcstandarddebit Mastercard standard debit card
mcpremiumcredit Mastercard premium credit card
mcpremiumdebit Mastercard premium debit card
mcsuperpremiumcredit Mastercard super premium credit card
mcsuperpremiumdebit Mastercard super premium debit card
mccommercialcredit Mastercard commercial credit card
mccommercialdebit Mastercard commercial debit card
mccommercialpremiumcredit Mastercard commercial premium credit card
mccommercialpremiumdebit Mastercard commercial premium debit card
mccorporatecredit Mastercard corporate credit card
mccorporatedebit Mastercard corporate debit card
mcpurchasingcredit Mastercard purchasing credit card
mcpurchasingdebit Mastercard purchasing debit card
mcfleetcredit Mastercard fleet credit card
mcfleetdebit Mastercard fleet debit card
mcpro Mastercard Proprietary card
mc_applepay Apple Pay for Mastercard
mc_androidpay Android Pay for Mastercard
maestro Maestro card
bijcard Bijenkorf Mastercard

Visa

Payment Method Variant/Card type Description
visa Visa card (not classified)
visadebit Visa debit card (not classified)
visacredit Visa credit card (not classified)
visastandardcredit Visa standard credit card
visastandarddebit Visa standard debit card
visapremiumcredit Visa premium credit card
visapremiumdebit Visa premium debit card
visasuperpremiumcredit Visa super premium credit card
visasuperpremiumdebit Visa super premium debit card
visacommercialcredit Visa commercial credit card
visacommercialdebit Visa commercial debit card
visacommercialpremiumcredit Visa commercial premium credit card
visacommercialpremiumdebit Visa commercial premium debit card
visacommercialsuperpremiumcredit Visa commercial super premium credit card
visacommercialsuperpremiumdebit Visa commercial super premium debit card
visacorporatecredit Visa corporate credit card
visacorporatedebit Visa corporate debit card
visapurchasingcredit Visa purchasing credit card
visapurchasingdebit Visa purchasing debit card
visafleetcredit Visa fleet credit card
visafleetdebit Visa fleet debit card

visadankort

Visa Dankort card
visaproprietary Visa proprietary card
visa_applepay Apple Pay for Visa
visa_androidpay Android Pay for Visa
vpay VPay card
electron Visa electron card

Others

Payment Method Variant/Card type Description
alipay Alipay wallet
amex Amex card
amex_applepay Apple Pay using Amex card
bcmc Bancontact debit card

boletobancario_santander

Boleto Bancario / Santander
cartebancaire Carte Bancaire
cup

UnionPay card

cupcredit

UnionPay credit card

cupdebit UnionPay debit card
diners Diners card
diners_applepay Apple Pay using Diners card

directEbanking

Sofort
discover Discover card
discover_applepay Apple Pay using Discover card

dotpay

Dotpay

elocredit

Elo card

idealabn

iDEAL via ABN AMRO

idealing

iDEAL via ING

idealrabobank

iDEAL via Rabobank
jcb JCB card

paypal

PayPal

sepadirectdebit_authcap

SEPA Direct Debit (AuthCap)

sepadirectdebit_received

SEPA Direct Debit (Received)

ServiceException

When the API request is rejected, the response message contains the following fields.

Field
Type
Required
Description
status String (tick) Returns the HTTP response status code.
errorCode String

(tick)

Returns the Adyen code that is mapped to the error message.
message String (tick) Returns the message, a short explanation of the issue.
errorType String (tick)

Returns the type of error that was encountered.

Allowed error types:

  • internal
  • validation
  • security
  • configuration