Getting Started - E-Commerce Acquiring

Eclipse handles the full card payment journey — card capture, 3DS authentication, and settlement — so you receive a payment link URL and the rest is managed by the platform.

What you'll build: a hosted payment link your customer can click to complete a card payment. Funds settle into your wallet automatically.

Time: under 15 minutes.

Full acquiring documentation: E-Commerce Card Not Present.

Prerequisites

• A sandbox tenant with API credentials (see Getting Started on Sandbox)
• A {destinationWalletId} — the wallet that received funds should settle into
• A valid JWT bearer token

Sandbox tenants are pre-configured with all payment types enabled on hosted checkout. No additional configuration is required to generate your first payment link.

Step 1 — Authenticate

POST {baseUrl}/eclipse-conductor/rest/v1/login
Content-Type: application/json

{
  "identity": "[email protected]",
  "password": "YourPassword123!"
}

Response:

{
  "headerName": "Authorization",
  "headerValue": "Bearer eyJhbGciOiJSUzI1NiJ9...",
  "tenantId": 42,
  "expires": "2026-05-19T10:30:00+00:00",
  "roles": ["TENANT_SYSTEM"]
}

Use headerValue as the value for the headerName header on every subsequent request. See Authentication & Authorisation for full details, including PKI-based auth for production. API Reference →

Step 2 — Generate a Payment Link

A single API call generates a secure, hosted payment URL. Eclipse handles the card capture form, 3DS verification, and payment processing.

POST {baseUrl}/eclipse-conductor/rest/v1/tenants/{tenantId}/payments
Authorization: Bearer {jwt}
Content-Type: application/json

{
  "type": "GLOBAL_PAYMENT_LINK",
  "externalUniqueId": "order-00001-2026-05-19",
  "destinationWalletId": "{destinationWalletId}",
  "currency": "ZAR",
  "amount": 299.00,
  "description": "Order #00001"
}

Response:

{
  "paymentId": 9284710,
  "paymentType": "GLOBAL_PAYMENT_LINK",
  "status": "PENDING",
  "currency": "ZAR",
  "amount": 299.00,
  "completionUrl": "https://checkout.eclipse.eftcorp.com/pay/abc123xyz",
  "expires": "2026-05-20T08:30:00.000Z",
  "created": "2026-05-19T08:30:00.000Z"
}

Share the completionUrl with your customer. When they open it, Eclipse presents a branded checkout page where they enter their card details and complete 3DS.

To embed the checkout in your own page, wrap the URL in an iFrame: Hosted Checkout iFrame.

For a reusable link (no fixed amount, can be paid multiple times): use GLOBAL_REUSABLE_PAYMENT_LINK as the type and omit amount.

API Reference: POST /tenants/{tenantId}/payments →

Step 3 — Test the Payment

Use this test card in the hosted checkout:

The payment will be processed in the sandbox with no real money movement. Full test card reference: Sandbox Testing Accounts.

Step 4 — Receive the Payment Callback

Eclipse posts a callback to your configured endpoint when payment is complete. Register your callback URL on the tenant.

Callback payload (example):

{
  "paymentId": 9284710,
  "status": "SUCCESSFUL",
  "amount": 299.00,
  "currency": "ZAR",
  "externalUniqueId": "order-00001-2026-05-19",
  "lastModified": "2026-05-19T08:32:15.000Z"
}

Verify callback authenticity using HMAC signature validation: HMAC Signature.

For synchronous payment processing (polling instead of callbacks): Synchronous vs Asynchronous Payments.

Step 5 — Check Payment Status

You can also poll payment status directly:

GET {baseUrl}/eclipse-conductor/rest/v1/tenants/{tenantId}/payments/{paymentId}
Authorization: Bearer {jwt}

Response:

{
  "paymentId": 9284710,
  "paymentType": "GLOBAL_PAYMENT_LINK",
  "status": "SUCCESSFUL",
  "amount": 299.00,
  "currency": "ZAR",
  "lastModified": "2026-05-19T08:32:15.000Z"
}

Once SUCCESSFUL, the funds are in the destination wallet.

API Reference: GET /tenants/{tenantId}/payments/{paymentId} →

Acquiring Modes

Eclipse supports three e-commerce acquiring models:

The mode is configured during onboarding. Contact [email protected] for setup.

Next Steps

Merchant Category Code (MCC)

Every acquiring tenant must have a valid MCC configured — a four-digit code for your business type. This is set up by [email protected] as part of production onboarding. Reference: MCC List.