Card Not Present (E-Commerce) Use Cases

Typically the acquiring options available to a tenant are the Eclipse payment processing capabilities described under Payment use cases - any payment option can be used by a tenant to collect money into a designated wallets. This includes but is not limited to:

Card Acquiring - e-Commerce card not present (CNP) payments including 3DS/AMT

Card Acquiring - Google Pay™

Card Acquiring - card present MPOS/Tap On Phone

Cash In at Retailer Acquiring - PicknPay

Instant EFT Acquiring - Ozow

  • Payment type and use case: ZA_OZOW

QR Acquiring - Masterpass Scan to Pay QR

QR Acquiring - Scan to Pay Deep Linking

  • On mobile devices this allows an application to invoke Scan To Pay supported applications (e.g. FNB, Nedbank, Capitec, Scan To Pay app) to complete a payment. For full details refer to Scan to Pay deep linking.

QR Acquiring - Mastercard QR (MCQR)

QQ Acquiring - VisaQR

Payment links - the ability to easily distribute payment requests using any of the above payment options through flexible single use or reusable payment links.

Apple Pay, Samsung Pay and Google Pay

MasterCard/Visa Integration with Eclipse Visa and Mastercard Click to Pay

Hosted Checkout

Tenants can choose to integrate directly to the payment APIs above as an enterprise integration - this allows full control of the UIX. An alternative option for easier and quicker integration is to use Eclipse Hosted Checkout.

Eclipse hosted checkout allows a tenant to easily generate a URL with a single API call using payment links (either a single use payment link or a more flexible reusable payment link) and the returned URL can be rendered for the customer to complete their payment. This includes the full card journey in terms of capturing card details, completing 3DS, etc.

Eclipse Hosted Checkout supports all Eclipse payment types and these can be enabled at a tenant level by setting the paymentType parameter in the global property public.tenant.{tenantId} - allowed values are mastercard, ozow, pnpcash and eft.

A tenant should be configured for all the payment types allowed on the hosted tenant page. Refer to Payments Use Cases for the prerequisites for each payment type.

Eclipse hosted checkout supports customer branding in terms of logo's, colours, etc. For full details refer to Customisation of the Captive Portal UI.

Generic Eclipse Hosted Checkout Desktop

Generic Eclipse Hosted Checkout Desktop

Generic Eclipse Hosted Checkout Mobile

Generic Eclipse Hosted Checkout Mobile

Enterprise Integration

This section describes acquiring options for tenants that want to integrate directly to the payment APIs as an enterprise integration.

📘

Note

Additional enterprise integration options for acquiring mentioned in the acquiring overview section e.g. Cash in at retailer acquiring, Instant EFT acquiring are all covered under Payment use cases.

Card Acquiring - E-commerce

Eclipse can be used to enable e-commerce for tenants who want to securely store tokenised card on file and process card not present (CNP) card payments including 3DS.

A typical use case would be an e-commerce retailer who wants to enable card payments through their existing customer channels. Eclipse APIs can be used to:

  1. To store and retrieve tokenised customer card on file details - refer to Card On File Management for full details.
  2. Initiate card payments using the card on file, through card rails with settlement to the designated merchant - refer to GLOBAL_WALLET payments for full details.

QR Acquiring - Masterpass Scan to Pay QR

Masterpass Scan to Pay QR Acquiring enables tenants in South Africa to securely generate Masterpass QR codes that are linked to an Eclipse wallet. Any Masterpass Scan to Pay supporting application can scan and pay these QR codes and the funds will be settled into the relevant Eclipse wallet.

Prerequisites

  • Eclipse digital wallet created
  • For merchant acquiring the created wallet should either be a tenant wallet (if the tenant is the acquiring merchant) or an organisation wallet (where the organisation is the acquiring merchant)
  • For merchant acquiring the merchant category code needs to be specified on the tenant if the tenant is the acquiring merchant or on the organisation if the organisation is the acquiring merchant. (Refer to MCC List for MCC codes)
  • The tenant must be signed up as a Masterpass merchant
  • The masterpass merchant setup must settle to the Nedbank acquiring pool account
  • API access must be enabled in the masterpass portal
  • Tenant config masterpass.config.aesKey must be set to the notification key.
  • Tenant config masterpass.config.apiUser and masterpass.config.apiPassword must be set to the masterpass API
  • credentials for the merchant
  • The masterpass notification URL must be set to https://ukheshe.live/eclipse-conductor/rest/v1/masterpass/incoming-payments?configId=XXX where XXX is the tenantId

Step 1 - Generate a QR Code

Tenants can generate a QR Code and link it to a specific wallet. An already created QR Code can be provided and linked to the wallet or a QR code can be generated as part of this API call. QR codes can also be generated for a specific amount and explicit expiry date if values are passed for amount and expires parameters. If these parameters are omitted the QR code will never expire and the amount will need to be provided then the payer would enter the amount upon payment.

QR codes are generated using the Create QR Endpoint:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/qr-codes
{
  "merchantName": "Johns Bakery",
  "type": "ZA_MASTERPASS",
  "description": "QR Code for Johns Bakery",
  "reference": "Ext-1234567"
}

Example response body:

{
  "walletId": 36714,
  "type": "ZA_MASTERPASS",
  "code": "2997973598",
  "currency": "ZAR",
  "reference": "Ext-1234567",
  "merchantName": "Johns Bakery",
  "description": "QR Code for Johns Bakery",
  "additionalFields": []
}

This QR Code can now be displayed or distributed through whatever means the channel intended and any Masterpass Scan to Pay supporting application can scan and pay the QR code and the funds will be settled into the wallet mapped to the QR code.

There are also endpoints to bulk create QR codes, update QR codes and bulk update QR codes.

QR Acquiring - MCQR

Mastercard QR (MCQR) enables tenants to generate MCQR codes that are linked to an Eclipse wallet. MCQR uses the concept of a receive only PAN as the destination of the payments. This means that a card needs to be issued and associated to the destination Eclipse wallet that must be created with mode receiveonlycard. MCQR is available in any region where MCQR is enabled.

Prerequisites

  • Card issuing program created for receive only cards

  • Eclipse wallet created with mode receiveonlycard

  • Tenant config mcqr.config.partnerId must be set to the notification key.

  • Any app generating MCQR codes must be certified by Mastercard

    Step 1 - Generate a QR Code

Tenants can generate a QR Code and link it to a specific wallet. An already created QR Code can be provided and linked to the wallet or a QR code can be generated as part of this API call. QR codes can also be generated for a specific amount and explicit expiry date if values are passed for amount and expires parameters. If these parameters are omitted the QR code will never expire and the amount will need to be provided then the payer would enter the amount upon payment.

QR codes are generated using the Create QR Endpoint:

This QR Code can now be displayed or distributed through whatever means the channel intended and any MCQR supporting application can scan and pay the QR code and the funds will be settled into the wallet that is associated to the receive only PAN.