Skip to content

MPGS setup

Genius Checkout supports two Mastercard Payment Gateway Services (MPGS) integrations:

  • MPGS Direct API — the buyer enters card details on the Genius Checkout payment page.
  • MPGS Hosted Payment Page — the buyer continues to a Mastercard-hosted payment page.

Your MPGS account is issued through your bank or acquirer—for example, Sagicor Bank Jamaica. This guide uses Sagicor in a few examples, but always use the Merchant ID, gateway URL, portal, and feature instructions supplied by your own provider.

Choose Direct API or Hosted Payment Page

MPGS Direct APIMPGS Hosted Payment Page
Card entryOn the Genius Checkout pageOn the MPGS-hosted page
Typical PCI scopeGreater scope; commonly SAQ A-EPLower scope; commonly SAQ A
Checkout brandingGenius Checkout brandingMerchant details and logo are sent to MPGS
Saved cards and subscriptionsSupported when tokenization is enabled by the bankNot supported by this Genius Checkout integration
3-D Secure controlsConfigurable in Genius CheckoutManaged by MPGS Hosted Checkout and the merchant profile
Payment actionAuthorize Only or Authorize & CaptureAuthorize Only or Authorize & Capture
Recommended whenYou need saved cards, subscriptions, or the most consistent on-site checkoutYou want MPGS to collect card details and minimize PCI scope

Confirm PCI scope

The table describes the normal integration model, not a compliance ruling. Confirm your final PCI DSS questionnaire and responsibilities with your acquiring bank or Qualified Security Assessor.

The bank must provision the model you select. Valid credentials alone do not automatically enable Direct API transactions, Hosted Checkout, 3-D Secure, tokenization, or every payment operation.

What your bank or acquirer gives you

The onboarding package from your bank or acquirer—for example, Sagicor—normally provides or enables:

ItemWhat it is used for
Merchant IDIdentifies the merchant profile. Test and live profiles are separate.
Merchant Administration URLPortal login. For example, Sagicor Jamaica uses https://sagicorbank.gateway.mastercard.com/ma.
Administrator loginUsed to create named portal operators. This password is not the API Password used by Genius Checkout.
Test merchant profileA separate test Merchant ID. In the Sagicor example this is commonly the live Merchant ID with TEST prefixed, but use the exact value your provider supplies.
Enabled currencies and cardsThe currencies and card brands the acquirer has approved for the profile.
Enabled operationsFor example AUTHORIZE, PURCHASE/PAY, CAPTURE, VOID, and REFUND.
3-D Secure / Hosted Checkout statusConfirms whether these services are active on the merchant profile.

You then create an operator and generate the API Password (Integration Auth) in the MPGS portal, following the instructions from your bank or acquirer.

Do not use the portal login password

Your Administrator or Operator password signs you into Merchant Administration. Genius Checkout requires the separate API password generated under Admin → Integration Settings.

Generate the API Password

The menu names below follow the standard portal flow used in the Sagicor example. If your bank's portal differs, follow its equivalent operator and integration-settings instructions.

  1. Sign in with the Administrator account provided by your bank.
  2. Open Admin → Operators.
  3. Create a named Merchant Administration operator with the integration privileges specified by your bank or acquirer.
  4. Sign out, then sign in as the new operator.
  5. Open Admin → Integration Settings and click Edit.
  6. Generate and enable Password 1, then submit the change.
  7. Copy the complete generated value. In the Sagicor example, this is a 32-character API password.

Sagicor instructions for opening Admin, choosing Integration Settings, and generating an API password

MPGS exposes two password slots so a password can be rotated without an immediate outage. Genius Checkout needs one enabled password; use Password 1 unless your bank or acquirer has instructed you to use Password 2.

Configure MPGS Direct API

Open Gateways, choose MPGS Direct API, and click Configure.

MPGS Direct API Test Environment configuration with Sagicor preset and safe example credentials

Complete the Test and Live cards independently:

Genius Checkout fieldEnter thisSource
Region presetSelect the preset for your provider; for example, SAGICOR for Sagicor profilesYour bank/acquirer
Gateway URLAuto-filled by a supported preset; for example, https://sagicorbank.gateway.mastercard.com for SagicorDerived by Genius Checkout or supplied by your provider
Merchant IDExact test or live Merchant IDYour bank/acquirer
API Password (Integration Auth)The enabled API password from Integration SettingsCreated by you in the MPGS portal
API VersionLeave 100 unless the bank explicitly requests another versionGenius Checkout default / bank instruction
Webhook notification secretLeave blank unless MPGS notifications have been coordinated with Genius Checkout supportMPGS notification configuration
Accepted currenciesOnly currencies enabled on that specific merchant profileYour bank/acquirer

Enter the Merchant ID exactly as issued. Genius Checkout automatically constructs the MPGS API username as merchant.<Merchant ID> when authenticating, so do not add merchant. to the field yourself.

For a custom MPGS host, select CUSTOM and enter the complete HTTPS gateway base URL provided by the acquirer. Do not include /ma or an API operation path.

Example: Sagicor test and live profiles

EnvironmentRegion presetMerchant IDAPI Password
TestSAGICORThe Sagicor test ID, commonly TEST + live IDAPI password generated for the test profile
LiveSAGICORLive Merchant IDAPI password generated for the live profile

Choose MTF only when the bank has specifically issued a Mastercard Test Facility profile and directed you to test-gateway.mastercard.com.

Direct API behavior

MPGS Direct API payment action and 3-D Secure behavior settings

FieldWhat it controls
Payment actionAuthorize & Capture charges immediately. Authorize Only places a hold that must later be captured or voided.
Enable 3D SecureStarts MPGS payer authentication. Enable only after the bank has activated 3-D Secure on the profile.
Require 3DSStops the payment if 3-D Secure cannot run. When off, an eligible payment may fall back to non-3DS processing.
Enable debug loggingDiagnostic logging. Keep this off in production unless Genius Checkout support requests a short troubleshooting window.
Order ID prefixUp to five characters placed before the order ID sent to MPGS. Use a unique prefix if one MPGS profile serves multiple stores.
Order description templateDescription sent with the order. {order_id} is replaced with the real order reference.

Before selecting Authorize & Capture, ask your bank or acquirer—for example, Sagicor—to confirm that PURCHASE/PAY is enabled. Before selecting Authorize Only, confirm that AUTHORIZE and CAPTURE are enabled and ask how long authorizations remain valid.

Configure MPGS Hosted Payment Page

Choose MPGS Hosted Payment Page when MPGS should collect the buyer's card details.

MPGS Hosted Payment Page Test Environment configuration with safe example values

The connection and credential fields use the same mapping as Direct API. The merchant profile must also have Hosted Checkout enabled.

Hosted payment behavior

  • Authorize & Capture sends a Hosted Checkout PURCHASE operation.
  • Authorize Only sends AUTHORIZE; capture or void the transaction later from Genius Checkout or the connected platform.
  • 3-D Secure is handled by the MPGS hosted flow and merchant profile, so the Direct API 3DS toggles are not shown.
  • Saved cards and subscription renewals are not available through the current MPGS Hosted Payment Page integration.

Merchant branding

MPGS Hosted Payment Page merchant branding fields

FieldGuidance
Display nameTrading name shown to the buyer. MPGS allows up to 40 characters.
Website URLPublic website URL, including https://.
Support emailCustomer-service email shown on the hosted page.
Support phoneCustomer-service phone number, including country code.
LogoSelect an image from the Genius Checkout media library or provide a public HTTPS URL. Keep the artwork square and centered.
Merchant addressRegistered business address shown by MPGS. Use the correct country and state/province/parish values.

Genius Checkout accepts a high-resolution square source image. MPGS displays the hosted-page logo in a much smaller area and its current API documentation recommends a 140 × 140 px rendered image with a maximum height of 140 px. Keep important artwork away from the edges so it is not cropped.

Webhook notifications

MPGS can notify Genius Checkout when an order changes after the buyer leaves the hosted page or after an asynchronous operation.

  • Notification URL: https://app.geniuscheckout.com/webhooks/mpgs
  • The URL must use HTTPS.
  • Notification delivery must be enabled in MPGS Merchant Administration.
  • The notification secret configured in MPGS must match the secret agreed with Genius Checkout.

Coordinate this setting

Do not invent a secret or enable MPGS notifications without contacting Genius Checkout support. Notification authentication is managed as part of gateway onboarding, and an unmatched secret will cause notifications to be rejected.

Bank-provisioning checklist

Ask your bank or MPGS acquirer—for example, Sagicor—to confirm all applicable items in writing:

  • Test and live Merchant IDs and gateway URL
  • Approved currencies and card brands
  • Web Services API access
  • AUTHORIZE and CAPTURE
  • PURCHASE/PAY if using Authorize & Capture
  • VOID and REFUND, including partial refunds
  • 3-D Secure for Direct API
  • Hosted Checkout for HPP
  • Tokenization if using saved cards or subscriptions through Direct API
  • Webhook notifications, if required

Test and go live

  1. Configure only the Test environment first.
  2. Save and click Test Connection. A successful test creates an empty authenticated MPGS session; it does not charge a card.
  3. Run the test-card scenarios supplied by your bank or acquirer, including approval, decline, and every required 3-D Secure path.
  4. If using Authorize Only, test capture and void.
  5. Test a captured refund.
  6. Add the separate live Merchant ID and live API password.
  7. Select only the live currencies enabled by your bank or acquirer.
  8. Test the Live connection, then process a low-value real payment and confirm it in Merchant Administration and settlement reporting.

Troubleshooting

SymptomCheck
HTTP 401 / wrong API passwordGenerate or re-copy the API password from Integration Settings. Do not use the portal login password.
HTTP 404 / merchant not foundConfirm Merchant ID, region preset, and gateway URL all belong to the same environment.
Connection succeeds but PURCHASE failsAsk the bank to enable PURCHASE/PAY or select Authorize Only.
3-D Secure cannot startConfirm 3-D Secure is enabled on the merchant profile and test cards are being used only in Test mode.
Hosted Checkout cannot startConfirm Hosted Checkout is enabled and the profile supports the requested currency.
Transaction remains pendingCheck the return flow, MPGS notification setup, and the transaction in Merchant Administration.

Processor references

Released under the proprietary Genius Checkout license.