Merchant Configuration — MPGS

Generated page — source of truth is schema/mpgs.yaml and values/mpgs-uat.yaml. Do not edit this file directly.

What is Merchant Configuration?

Configuring an MPGS merchant in MGMT begins with two back-office API calls: creating or updating the Group record and then the Merchant record. These establish the merchant's identity, routing region, currency, business system, and gateway credentials before any payment method configuration is applied.

Getting this layer right matters because several downstream fields depend on values set here. The regionId determines which country codes are valid. The bizSystemId determines the Astral product context. Errors at this layer cascade into every transaction the merchant processes.

Provisioning Order

The full provisioning sequence is documented in Merchant Configuration Lifecycle. For this gateway, the merchant-layer steps are:

1. Group (optional — only when the merchant belongs to a named group)
       ↓
2. Merchant (required — identity, region, currency, gateway credentials)
       ↓
3. MPG Array → see MerchantPaymentGateway Configuration
4. API User
5. Terminals + Terminal Configs
6. STS Token Space / Repository

Group

A group record is optional. Create one only when the property requires merchants to be associated under a named group in MGMT. If no group is required, the groupId field on the merchant record uses a default value and no group API call is needed.

When group_name is provided, the template also sets aliasName and comment to the same value. When it is not provided, the entire group block is omitted from the provisioning call.

Source: {{baseUrl}}/v1/group?aliasName={groupName}&groupName={groupName}&status=1

Merchant Identity

These fields establish who the merchant is in MGMT. They are required for every MPGS merchant regardless of which SKU is being configured.

Region → Country dependency: countryCode must be a valid ISO code for the selected regionId. Source: {{baseUrl}}/v1/list/country/:regionId

Region codes reference: Region Codes (BLOCKED — data/reference/regions.yaml not yet populated. See OI-004.)

Merchant Commerce Settings

These fields control transaction routing, currency, and the business system context.

Currency codes resolve via {{baseUrl}}/v1/list/currency. The UAT default is 036 (AUD) — this reflects the UAT environment context and should be overridden for non-AUD properties.

Business system IDs map to Astral product contexts (Infrasys, MyCheck, Shiji Enterprise Platform, etc.). The default 000006 is MyCheck. Confirm the correct ID with the implementation team before provisioning. See Business Systems.

Merchant Gateway Credentials

MPGS requires a shared secret stored on the merchant record. This is the primary MGMT-to-MPGS authentication credential.

Additional field set by the template directly (not from values file):

Fixed Template Values

The following fields are written by the provisioning template with fixed values. They are not configurable per-merchant. They are documented here so that engineers understand what the provisioning call contains.

Open Items

See Also

• MerchantPaymentGateway Configuration — the five MPG entries required for MPGS
• Terminal Configuration — terminal and terminalConfig fields
• Tokenisation — STS token space setup
• Field Catalog — complete field reference with types and constraints
• Business Systems Reference

Collecting Credentials from the MPGS Portal

When your MPGS portal setup is complete, the following credentials will be issued. Use this table to map the portal label to the correct field in the Astral MGMT configuration.

These are secrets. Never store in source control or share in plain text. Supply via the secrets manager.

🔒 = secret field — supply via secrets manager, never hardcode.