E-Commerce Sandbox

Test Payments in a Safe Environment

Build, test, and perfect your payment integration before going live. Hosted checkout, server-side result verification, and comprehensive test scenarios.

Try Test Payment API Documentation Check BIN

PHP Python Java C# Node.js

                                
                            
payment.js

# Create a hosted checkout session
curl -X POST "$BASE_URL/v1/checkouts" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d "entityId=$ENTITY_ID" \
  -d "amount=10.00" \
  -d "currency=USD" \
  -d "paymentType=DB"

# After the shopper returns, verify with GET resourcePath
                        

E-Commerce Sandbox Features

Everything You Need to Integrate

Sandbox Credentials

Use separate test credentials to simulate payment journeys without affecting production data.

Shopper Result URL

The gateway redirects the shopper to your result URL with a resourcePath. Verify that path on your server before fulfilment. This is not an asynchronous webhook feed.

E-Commerce Sandbox API Keys

Separate test credentials ensure your sandbox activity never affects production data.

Transaction History

View detailed logs of all test transactions including requests, responses, and statuses.

Refunds and reversals

Refund (RF) and reversal operations depend on acquirer enablement. Confirm availability with your bank before treating them as production-ready.

Security Testing

Validate signature verification and ensure your integration is secure before going live.

API Reference

RESTful API Endpoints

Our API follows REST conventions with predictable URLs, JSON request/response bodies, and standard HTTP methods.

HTTPS only for all requests

Bearer token authentication

JSON request/response format

Idempotency support

POST /v1/checkouts

Create a hosted checkout session. Host is environment-specific (UAT or live). Do not send credentials in examples.

GET {resourcePath}?entityId=...

Verify payment status using the returned resourcePath. Empty body. Do not reuse the create-checkout fields.

POST Refund / reversal

Requires confirmation: RF/reversal APIs depend on acquirer enablement and are not presented as production-ready here.

GET Shopper result URL

Browser return URL after payment. This is not an asynchronous webhook. Confirm server-to-server notifications separately if they are provisioned.

Try It Now

Simulate a Test Payment

Test the full payment flow with our secure sandbox environment

Advanced Payments Hub

Payment Scenario

Run a standard Copy-and-Pay checkout.

Testing Mode

Use sandbox mode to simulate payment journeys with test credentials and test cards. No live funds are debited.

Live card testing is restricted to authorised support users. Live card testing is not enabled on this environment.

Amount

Currency

Payment Method

Use your own merchant credentials for testing. These override default sandbox credentials for this request only.

Pay Mode

Pay Source

Entity ID (optional)

Authorization Bearer (optional)

Credentials are used only for this request and are not stored.

COPYandPAY Integration Guide

Prepare checkout, render the widget, and verify payment status step-by-step.

Need Help Integrating?

Our technical team is ready to assist you with your integration. Get hands-on support from developers who understand the Zimswitch platform.

Contact Support General Enquiries Knowledge Centre

Live Developer Support