Mpgs -- 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: Mpgs 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-0006-A-110000 0006-A / SPF ALL 0, 1 In Development
C2C-ALL-0006-A-010010 0006-A / SPF ALL 1, 4 In Development

Contents

Group (group)

MGMT Field Required Type Len Value / Default Description
groupId Conditional string -- -- Group ID (aliasName and groupName are set to group_name when provided)
groupName Conditional string -- -- Group name — also written to aliasName and comment. Optional block.

Back to top

Merchant (merchant)

MGMT Field Required Type Len Value / Default Description
description Optional string -- -- Free-text merchant description
merchantName Mandatory string -- -- Merchant display name
regionId Mandatory enum -- -- Region ID (e.g. 2 = Asia Pacific)
Allowed values: see Regions ref
countryCode Mandatory enum -- -- ISO alpha-3 country code (e.g. AUS)
Allowed values: see Countries ref
Requires: REGION_ID
addr Conditional string -- <secret> (supply via secure channel) Merchant street address
currencyCode Conditional enum -- 840 ISO numeric currency code (e.g. 840 = USD, 036 = AUD)
Allowed values: see Currency Codes ref
timeZone Conditional string -- UTC Merchant timezone (IANA tz string, e.g. Australia/Sydney)
bizSystemId Conditional enum -- 000006 Business system ID
Allowed values: see Business Systems ref
billingMethod Conditional enum -- B04 Billing method
Allowed values: see Billing Methods ref
state Conditional string -- GA Merchant state
city Conditional string -- Atlanta Merchant city
secretData1 Mandatory string -- <secret> (supply via secure channel) MPGS merchant shared secret / API credential
extData7 Conditional string -- 1m [unconfirmed] Token/data retention period (default 1m). Exact format and allowed values to confirm.

Back to top

Terminal (terminal)

MGMT Field Required Type Len Value / Default Description
terId Mandatory string -- <secret> (supply via secure channel) Terminal ID — also written to workstationId

Back to top

Terminal Config (terminalConfig)

MGMT Field Required Type Len Value / Default Description
extData1 Conditional enum -- true Allow partial authorisations
Values: true=Partial authorisations allowed / false=Partial authorisations disabled
extData3 Conditional string -- 72 MPGS API version
asyncFlag Mandatory enum -- -- Processing mode for this terminal config row (0=sync, 1=async)
Values: 0=Synchronous processing / 1=Asynchronous processing
channelId Mandatory string -- -- Channel ID for this terminal config row (matches mpgs_sync_channel or mpgs_async_channel)
channelTerminalId Mandatory string -- <secret> (supply via secure channel) Acquirer / gateway terminal ID
channelMerchantId Mandatory string -- <secret> (supply via secure channel) Acquirer / gateway merchant ID

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
partnerEmail Conditional string -- <secret> (supply via secure channel) STS API user / operator email

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 value across all MPG entries

PM0 -- Bank Card

MGMT Field Required Type Len Value / Default Description
extData1 Mandatory url -- <secret> (supply via secure channel) MPGS host URL (e.g. https://ap-gateway.mastercard.com)
extData2 Mandatory string -- <secret> (supply via secure channel) MPGS API key / merchant ID at the host
extData3 Mandatory string -- <secret> (supply via secure channel) MPGS API password
channelId Mandatory string -- -- MGMT channel ID for synchronous card-present processing

PM1 -- Token

Role: Token (Sync)

MGMT Field Required Type Len Value / Default Description
channelId Mandatory string -- -- Channel ID for token sync MPG entry (defaultFlag=1)
extData1 Mandatory url -- <secret> (supply via secure channel) MPGS host URL — token sync MPG
extData2 Mandatory string -- <secret> (supply via secure channel) MPGS API key — token sync MPG
extData3 Mandatory string -- <secret> (supply via secure channel) MPGS API password — token sync MPG

Role: Token (Async)

MGMT Field Required Type Len Value / Default Description
channelId Mandatory string -- -- Channel ID for token async MPG entry (defaultFlag=0)
extData1 Mandatory url -- <secret> (supply via secure channel) MPGS host URL — token async MPG
extData2 Mandatory string -- <secret> (supply via secure channel) MPGS API key — token async MPG
extData3 Mandatory string -- <secret> (supply via secure channel) MPGS API password — token async MPG

PM4 -- Ecommerce

Role: Ecom Widget (HPP)

MGMT Field Required Type Len Value / Default Description
channelId Mandatory string -- -- Channel ID for ecom widget MPG (HPP/hosted payment page, defaultFlag=1, tpduName=All)

Role: Ecom Processing

MGMT Field Required Type Len Value / Default Description
channelId Mandatory string -- -- Channel ID for ecom processing MPG (async, tpduName=CreditCard, defaultFlag=0)
extData1 Mandatory url -- <secret> (supply via secure channel) MPGS host URL — ecom processing MPG
extData2 Mandatory string -- <secret> (supply via secure channel) MPGS API key — ecom processing MPG
extData3 Mandatory string -- <secret> (supply via secure channel) MPGS API password — ecom processing MPG
extData9 Conditional enum -- mandatory Cardholder name capture rule for ecom processing
Values: mandatory, optional, disabled
extData10 Conditional string -- 40-45,visa|2221-2720,mastercard|51-55,mastercard|34-34,amex|37-37,amex|60-649,discover|30-39,diners|3528-3589,jcb Card BIN range routing rules — pipe-separated list of range,scheme pairs

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