Integration Guides
Start typing to search…

Getting Started with E-Commerce Acquiring

Eclipse provides a full suite of acquiring capabilities, enabling tenants to process payments across multiple channels, including e-commerce (card-not-present) and card-present scenarios. It supports complex integrations as well as simple hosted checkout setups. Full documentation on payment types and use cases can be found here: Payments Use Cases.

E-commerce acquiring can be offered in three modes:

  • Individual Sales Organisation (ISO): Tenant holds a merchant account with a bank.
  • EFT as Super Merchant: EFT Corporation acts as an aggregator for the tenant.
  • Tenant-Onboarded Merchants: Tenants onboard merchants themselves; digital KYC/KYB is required using the Merchant Aggregation KYC Ruleset.

This section guides you through quickly getting started with e-commerce acquiring while full integration details are covered here: E-Commerce Card Not Present.

1. Generate Your First Payment Link

Sandbox tenants are preconfigured with all payment types enabled in the hosted checkout page. A single API call can generate a payment link that can be shared via WhatsApp or embedded in an iFrame. Eclipse hosted checkout handles the full card journey, including card detail capture and 3DS authentication.

Payment links can also be generated the admin portal - for a single use payment link only currency and destination wallet are required to create a payment link:

Example API call to generate a payment link:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/payments
{
	"type": "GLOBAL_PAYMENT_LINK",
	"externalUniqueId": "ee12ebd0-1761-4416-8fc3-e754e5b8aabf",
	"destinationWalletId": 2550312,
	"currency": "ZAR"
}

The returned completionUrl can be shared directly with customers or iframed: Hosted Checkout iFrame.

Direct API integrations for all payment types are also available: Payments Use Cases.

2. Brand Your Payment Link

Eclipse hosted checkout supports full branding: logos, primary/secondary colours, and tenant-specific themes.

  • Share your branding with [email protected] to enable it for your tenant.
  • Branding can be tenant-wide or customised for specific sub-organisations.
  • Self-service hosted checkout branding is coming soon.

For more info, see: Hosted Checkout Customisation.

3. Scheduled Withdrawals

Acquired funds are collected in wallets.

  • ISO mode: funds settle directly to the tenant’s merchant account.
  • EFT aggregator mode: funds are first collected into an EFT merchant account, then settled to the destination wallet.

Tenant wallets can be created as needed to track payments per division or settlement target. Scheduled withdrawals can transfer funds to a bank account via API or the Admin Portal: Recurring Withdrawals.

4. Authentication

Eclipse uses JWT-based authentication for API access. Details on requesting and refreshing tokens are available here: Authentication & Authorisation.

The Admin Portal handles authentication automatically. For production deployments, PKI-based authentication is recommended: PKI Authentication.

5. Callback Security

Eclipse supports synchronous and asynchronous payment processing: Synchronous vs Asynchronous Payments.

  • Asynchronous callbacks are recommended for efficiency.
  • HMAC signatures should be used to verify callback authenticity: HMAC Signature.

6. Refunds and Reversals

Eclipse supports refunds and reversals via API and Admin Portal:

7. Tokenised Card on File

Eclipse supports storing card on file using scheme tokenisation:

A common scenario is for acquirers to use Eclipse to securely store customer cards on file, while the customer profile and other details remain on the tenant’s platform. In this setup, a placeholder customer can be created on your tenant account, and all cards on file are associated with that customer. When a card is stored, Eclipse returns a unique identifier, which the tenant can save against the customer profile on their own system. This identifier can then be used for processing future payments. Full guidance on managing cards on file is available here: Card on File Management.

8. Reporting

Eclipse provides detailed transaction and statement reporting. Reports can be accessed via the Admin Portal or APIs. Tenants are encouraged to integrate Eclipse reporting into their own data warehouse for aggregation and historical analysis.

9. Merchant Category Code (MCC)

Tenants must configure a valid Merchant Category Code (MCC) for acquiring. MCC is a four-digit code representing the type of service offered. Lists are publicly available via Mastercard and Visa websites. This will be configured on your tenant by [email protected] as part of the productionisation process.

Updated 35 minutes ago