C2C-ALL-0006-A-010010

Generated -- do not edit by hand. Regenerate: acd build C2C-ALL-0006-A-010010

Contents


1. What Is This?

Mpgs Single Point of Failure (SPF) product code for C2C Ecommerce (C2C) in the ALL region.

Active payment methods: Token + Ecommerce. No 3DS.

Default transaction flows: sale, auth, capture, void, refund

Business context: This SKU is intended for C2C ecommerce merchants that need tokenized checkout and hosted payment-page support through the MPGS SPF integration.

Characteristics

Characteristic Value
Architecture SPF
3DS / MPI No
Tokenization Yes
Bank Card No
Ecommerce (HPP) Yes
QR Code No
Gift Card No
Partial Auth Yes

2. SKU Breakdown

+-----+-----+------+----+--------+
| C2C | ALL | 0006 | A  | 010010 |
+-----+-----+------+----+--------+
Segment Value Meaning
Industry C2C C2C Ecommerce (reference)
Region ALL (reference)
Solution 0006 Mpgs / SPF (reference)
Variant A (author meaning in reference/sku-naming.md)
Capabilities 010010 PM1, PM4 active (reference)

3. Capabilities

Payment Methods

PM Slot Payment Method Active
PM0 Bank Card No
PM1 Token Yes
PM2 QR MS No
PM3 QR GS No
PM4 Ecommerce Yes
PM5 Gift No
PM99 MPI / 3DS No

Product Family — Solution 0006

SKU Industry Variant PM0 PM1 PM4 3DS
C2C-ALL-0006-A-010010 C2C 0006-A No Yes Yes No
FNB-ALL-0006-A-110000 FNB 0006-A Yes Yes No No

Channel References (UAT)

Channel IDs from the UAT values file. SIT and PROD IDs belong in data/channels/ (not yet created).

Purpose Channel ID Var
Ecom Widget Channel (HPP) 20336 ecom_widget_channel
Mpgs Async Channel 20188 mpgs_async_channel
Mpgs Sync Channel 20189 mpgs_sync_channel

4. Merchant Configuration

Configure the following MGMT objects in order. Each row = one API call.

Step MGMT Object Table Required Notes
1 Group group Y Step 1
2 Merchant merchant Y Step 2
3 Terminal terminal Y Step 3
4 Terminal Config terminalConfig Y Step 4
5 STS Token / Repository sts Y Step 5
6 merchantPaymentGateway merchantPaymentGateway Y [ ] PM0 [x] PM1 [ ] PM2 [ ] PM3 [x] PM4 [ ] PM5

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


5. Configuration Details

Columns: Key = provisioning identifier | MGMT Field = API body field name | Sample = UAT value (seed; verify before PROD) | Source = origin of the value

Step 1: Group (group)

Key MGMT Field Type Required Sample (UAT) Notes
GROUP_ID groupId string Conditional 1164 Group ID (aliasName and groupName are set to group_name when provided)
GROUP_NAME groupName string Conditional -- Group name — also written to aliasName and comment. Optional block.

Step 2: Merchant (merchant)

Key MGMT Field Type Required Sample (UAT) Notes
MERCHANT_DESCRIPTION description string Optional -- Free-text merchant description
MERCHANT_NAME merchantName string Mandatory <merchant_name> Merchant display name
REGION_ID regionId enum Mandatory 2 Region ID (e.g. 2 = Asia Pacific)
Allowed values: see Regions ref
COUNTRY_CODE countryCode enum Mandatory AUS ISO alpha-3 country code (e.g. AUS)
Allowed values: see Countries ref
Requires: REGION_ID
ADDR addr string Conditional <secret> (supply via secrets manager) Merchant street address
CURRENCY_CODE currencyCode enum Conditional 036 ISO numeric currency code (e.g. 840 = USD, 036 = AUD)
Allowed values: see Currency Codes ref
TIMEZONE timeZone string Conditional Australia/Sydney Merchant timezone (IANA tz string, e.g. Australia/Sydney)
BUSINESS_SYSTEM bizSystemId enum Conditional 000006 Business system ID
Allowed values: see Business Systems ref
BILLING_METHOD billingMethod enum Conditional B04 Billing method
Allowed values: see Billing Methods ref
STATE state string Conditional <state> Merchant state
CITY city string Conditional <city> Merchant city
SECRET_DATA1 secretData1 string Mandatory <secret> (supply via secrets manager) MPGS merchant shared secret / API credential
EXTDATA7_RETENTION extData7 string Conditional 1m (default) [unconfirmed] Token/data retention period (default 1m). Exact format and allowed values to confirm.

Step 3: Terminal (terminal)

Key MGMT Field Type Required Sample (UAT) Notes
TERMINAL_ID terId string Mandatory <secret> (supply via secrets manager) Terminal ID — also written to workstationId

Step 4: Terminal Config (terminalConfig)

Key MGMT Field Type Required Sample (UAT) Notes
PARTIAL_AUTH extData1 enum Conditional true (default) Allow partial authorisations
Values: true=Partial authorisations allowed / false=Partial authorisations disabled
API_VERSION extData3 string Conditional 72 MPGS API version
ASYNC_FLAG asyncFlag enum Mandatory -- Processing mode for this terminal config row (0=sync, 1=async)
Values: 0=Synchronous processing / 1=Asynchronous processing
TERMINAL_CHANNEL_ID channelId string Mandatory -- Channel ID for this terminal config row (matches mpgs_sync_channel or mpgs_async_channel)
CHANNEL_TERMINAL_ID channelTerminalId string Mandatory <secret> (supply via secrets manager) Acquirer / gateway terminal ID
CHANNEL_MERCHANT_ID channelMerchantId string Mandatory <secret> (supply via secrets manager) Acquirer / gateway merchant ID

Step 5: STS Token / Repository (sts)

Key MGMT Field Type Required Sample (UAT) Notes
STS_SPACE spaceName string Conditional mcli Token space name
STS_REPO repositoryName string Conditional mcli Token repository name
USER_EMAIL partnerEmail string Conditional <secret> (supply via secrets manager) STS API user / operator email

Step 6: Merchant Payment Gateways (merchantPaymentGateway) -- Array

4 entries required. Provision in the order listed below.

Common fields (all entries)

Key MGMT Field Type Required Sample (UAT) Notes
GATEWAY_ID gatewayId string Conditional Tp2 (default) Gateway ID — same value across all MPG entries

Entry 1 -- PM1 -- Token (Async)

Key MGMT Field Type Required Sample (UAT) Notes
TOKEN_ASYNC_CHANNEL channelId string Mandatory 20188 Channel ID for token async MPG entry (defaultFlag=0)
TOKEN_ASYNC_HOST_URL extData1 url Mandatory <secret> (supply via secrets manager) MPGS host URL — token async MPG
TOKEN_ASYNC_HOST_KEY extData2 string Mandatory <secret> (supply via secrets manager) MPGS API key — token async MPG
TOKEN_ASYNC_HOST_PASSWORD extData3 string Mandatory <secret> (supply via secrets manager) MPGS API password — token async MPG

Entry 2 -- PM1 -- Token (Sync)

Key MGMT Field Type Required Sample (UAT) Notes
TOKEN_SYNC_CHANNEL channelId string Mandatory 20189 Channel ID for token sync MPG entry (defaultFlag=1)
TOKEN_SYNC_HOST_URL extData1 url Mandatory <secret> (supply via secrets manager) MPGS host URL — token sync MPG
TOKEN_SYNC_HOST_KEY extData2 string Mandatory <secret> (supply via secrets manager) MPGS API key — token sync MPG
TOKEN_SYNC_HOST_PASSWORD extData3 string Mandatory <secret> (supply via secrets manager) MPGS API password — token sync MPG

Entry 3 -- PM4 -- Ecom Processing

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

Entry 4 -- PM4 -- Ecom Widget (HPP)

Key MGMT Field Type Required Sample (UAT) Notes
ECOM_WIDGET_CHANNEL channelId string Mandatory 20336 Channel ID for ecom widget MPG (HPP/hosted payment page, defaultFlag=1, tpduName=All)

6. Open Items -- Needs Sign-off

Fields marked confirm: true in the schema. Verify before production.


7. See Also

Page metadata | | | |:---|:---| | SKU | `C2C-ALL-0006-A-010010` | | Schema source | `schema/mpgs.yaml` | | Values source | `values/` (see `_VALUES_MAP` in project.py) | | Generated by | `