Adyen -- Gateway Field Catalog

Generated constant-layer reference -- every field this gateway can use.
Per-SKU requirement is resolved on each product-code page.
See also: Adyen Supported Transaction Types

Secret fields -- cells marked <secret> contain credentials or PII. Never commit actual values to source control. Supply via your secrets manager or provisioning vault.

Product Codes Using This Gateway

SKU Variant Region MPGs Status
FNB-ALL-0001-A-110000 0001-A / SPF ALL 0, 1 In Development

Contents

Group (group)

MGMT Field Required Type Len Value / Default Description
groupId Conditional enum -- 1160 Group ID
Lookup: {{baseUrl}}/v1/group?aliasName={groupName}&groupName={groupName}&status=1
groupName Conditional string -- -- Group name (also aliasName/comment)

Back to top

Merchant (merchant)

MGMT Field Required Type Len Value / Default Description
merchantName Mandatory string -- -- Merchant display name
regionId Mandatory enum -- -- Region ID
Allowed values: see Regions ref
countryCode Mandatory enum -- -- ISO country code
Allowed values: see Countries ref
Requires: REGION_ID
currencyCode Conditional enum -- 840 ISO numeric currency (e.g. 840 = USD, 978 = EUR)
Allowed values: see Currency Codes ref
bizSystemId Conditional enum -- -- Business system ID
Allowed values: see Business Systems ref
billingMethod Conditional enum -- B04 Billing method
Allowed values: see Billing Methods ref
serviceEntry Conditional enum -- 1 [unconfirmed] Service entry mode (1 = ?, other values undocumented)
addr Conditional string -- <secret> (supply via secure channel) Address
city Conditional string -- -- City
state Conditional string -- -- State
extData2 Mandatory string -- <secret> (supply via secure channel) Adyen Master API Key (an alternate API key is also accepted)
extData3 Conditional enum -- RESTAURANT Industry type; falls back to RESTAURANT when empty
Values: LODGING=Lodging industry profile / RESTAURANT=Restaurant/F&B profile / RETAIL=Retail profile
extData4 Mandatory url -- <secret> (supply via secure channel) Host DNS. UAT/SIT: :// (no trailing slash/space). PROD: location/merchant PREFIX only, e.g. -
extData5 Conditional string -- <secret> (supply via secure channel) Terminal API DNS — applicable to Card Present only
card present only
extData6 Mandatory string -- V71 Adyen host/API version (e.g. V71)
extData7 Conditional enum -- FALSE Smart Auth toggle
Values: TRUE=Smart Auth enabled (must also be enabled in the Adyen portal) / FALSE=Smart Auth disabled
extData8 Conditional enum -- FALSE Enable ZIP input (ecom + SPF only)
Values: TRUE=ZIP input enabled / FALSE=ZIP input disabled
ecom only, SPF only
extData9 Conditional enum -- FALSE Lodging metadata-only mode (Card Present only)
Values: TRUE=Send only .metadata lodging fields / FALSE=Send full .lodging fields
card present only
extData10 Conditional string -- -- SKU stamp = merchant<->docs join key (reserved for SKU; currently UNWIRED)

Back to top

API User (apiuser)

MGMT Field Required Type Len Value / Default Description
apiUserTemplate Conditional string -- -- API user — derived: MERCHANT without whitespace + xx (derived: MERCHANT name without whitespace + 'xx')

Back to top

Terminal (terminal)

MGMT Field Required Type Len Value / Default Description
terId Mandatory string -- -- Terminal ID (also workstationId)
integrateFlag Conditional string -- NO [unconfirmed] integrateFlag (sample NO; allowed values/meaning undocumented)
extData1 Conditional enum -- -- Tip workflow enabled
Values: TRUE=Tipping workflow enabled / FALSE=Disabled
extData2 Conditional enum -- -- RENDERED — receipt rendering
Values: TRUE=Receipt rendering enabled / FALSE=Disabled
extData3 Conditional enum -- -- Surcharge enabled
Values: TRUE=Surcharge enabled / FALSE=Disabled
extData5 Conditional enum -- -- Allow partial approvals
Values: TRUE=Partial approvals allowed / FALSE=Not allowed
extData6 Conditional enum -- FALSE Suppress alternative payment methods on Authorization (ecom only)
Values: TRUE=Suppress alternative payment methods on auth / FALSE=Show them
ecom only

Back to top

Terminal Config (terminalConfig)

MGMT Field Required Type Len Value / Default Description
channelMerchantId Mandatory string -- <secret> (supply via secure channel) Adyen merchant account
channelTerminalId Mandatory string -- <secret> (supply via secure channel) Adyen POIID (terminal identifier, e.g. -)
extData1 Conditional int -- 170000 Host timeout (ms)
extData2 Conditional string -- -- Unsupported card-type mapper (pre-auth). MS uses adyenUS
extData3 Conditional enum -- Standard Card token type
Values: Extended=Concatenate shopperReference + recurringDetailReference as the token returned to C2C / Standard=shopperReference returned as the token (default) / OPI=⚠ OPI mode — meaning not documented
required for Card Present and Ecom HPP
extData4 Optional string -- -- Adyen store (partner platform integrations only)
extData5 Optional string -- -- [unconfirmed] recurringProcessingModel override — purpose to confirm with Jakub

Back to top

STS Token / Repository (sts)

MGMT Field Required Type Len Value / Default Description
spaceName Conditional string -- mcli Token space name
repositoryName Conditional string -- mcli Token repository name

Back to top

merchantPaymentGateway (merchantPaymentGateway)

Each MPG entry is one row in the payment gateway array. A product code's required combination is on each SKU page.

Common fields -- all PM entries

MGMT Field Required Type Len Value / Default Description
gatewayId Conditional string -- Tp2 Gateway ID (same across all MPG entries)
STSTokenChannel Mandatory string -- 20559 STS token channel — needed for global token (card present) and MS alias-token flows

PM0 -- Bank Card

MGMT Field Required Type Len Value / Default Description
extData2 Mandatory string -- ADYEN2.V2 Mapper for Bank Card MPG (SPF). In MS, this field is TTL to wait for webhook in ms (e.g. 160000)
extData3 Mandatory enum -- TRUE Wait-for-webhook toggle (PM0/PM1)
Values: TRUE=Wait for webhook before responding / FALSE=Use gateway sync response

PM1 -- Token

MGMT Field Required Type Len Value / Default Description
extData2 Mandatory string -- ADYEN2.V2 Mapper for Token MPG (SPF). In MS, this field is TTL to wait for webhook in ms
extData4 Conditional string -- 20559 STS Token Channel (global-token / card-present flows)

PM4 -- Ecommerce

MGMT Field Required Type Len Value / Default Description
extData1 Conditional enum -- TRUE HPP iframe limitation — auto force pop-out instead of card capture. Mandatory for ecom
Values: TRUE=Force pop-out window (iframe not supported) / FALSE=Allow page-jump (only units that support it)
extData2 Mandatory string -- ADYEN2-ECOMMERCE.V2 Mapper for Ecommerce MPG (SPF). In MS, this field is the ecom payment-page expiry in ms (e.g. 140000)
extData5 Conditional string -- <secret> (supply via secure channel) Adyen Client Key — SPF ecommerce (also MS for Mycheck ecom token)
extData6 Conditional string -- -- [unconfirmed] allowPaymentMethods (SPF only) — exact format/values undocumented
SPF only
extData7 Conditional string -- v6.22.0 Adyen web SDK version — SPF ecommerce
extData8 Conditional string -- US adyenCountry (ecom). Leave empty for Fletcher (sent in request)
extData9 Conditional string -- <secret> (supply via secure channel) Webhook HMAC key (required if webhook toggle is TRUE)
required when wait-for-webhook = TRUE
Requires: WAIT_FOR_WEBHOOK_CP
extData10 Conditional string -- -- Adyen hosted-checkout themeId (from Adyen portal). Mandatory for ecom

Back to top

Reference: Enum Lookup Pages

Billing Methods

Used by: billingMethod
Resolved at runtime via the MGMT API -- consult the Billing Methods lookup endpoint.

Business Systems

Used by: bizSystemId
Resolved at runtime via the MGMT API -- consult the Business Systems lookup endpoint.

Countries

Used by: countryCode
Resolved at runtime via the MGMT API -- consult the Countries lookup endpoint.

Currency Codes

Used by: currencyCode
Resolved at runtime via the MGMT API -- consult the Currency Codes lookup endpoint.

Regions

Used by: regionId
Resolved at runtime via the MGMT API -- consult the Regions lookup endpoint.

See Also