Sandbox Setup
Last updated: 2026-03-22
Prerequisites
Before you begin, make sure you have:
- Sandbox credentials from Westpay Support (see Sandbox Overview)
- Your Subscription Key
- Your Bearer Access Token
- A modern browser (Chrome, Firefox, Edge, or Safari)
Step 1 — Open the Sandbox
Navigate to /sandbox in the developer portal.
The portal checks for saved credentials in your browser. If none are found you are redirected to the sign-in page automatically.
Step 2 — Enter Your Credentials
On the Sign In page, enter:
| Field | Description |
|---|---|
| Subscription Key | Your Ocp-Apim-Subscription-Key value provided by Westpay |
| Bearer Token | Your merchant access token (used in the Authorization: Bearer … header) |
Click Access Sandbox. Your credentials are stored in browser local storage for the session so you do not need to re-enter them on each visit.
Security note: Credentials are stored only in your browser's local storage and are never sent to the portal server. All API calls are made directly from your browser to the Westpay QA API.
Step 3 — Connect the Terminal Simulator
After signing in you land on the ECR Simulator tab. Switch to the Terminal Simulator tab in the top navigation bar.
The simulator automatically establishes a SignalR connection to the Westpay backend. You will see:
- A Connection ID chip in the toolbar — this identifies your real-time session
- The virtual terminal display showing a registration code
Wait for the connection indicator in the header to show Connected before proceeding.
If the connection fails, check that your Subscription Key is correct. The SignalR hub authenticates using the same key.
Step 4 — Configure the ECR Simulator
Switch back to the ECR Simulator tab and click Configure in the top-right corner of the console. The ECR Configuration dialog opens with two tabs:
Authorization tab
Verify your Subscription Key and Bearer Token are shown. If you need to update them, edit the fields and click Save & Continue.
Terminal tab
The Simulation Mode toggle is ON by default. When active:
| Field | Behavior |
|---|---|
| Connection ID | Auto-filled from the Terminal Simulator session |
| Terminal ID | Auto-synced from the virtual terminal (80000800 by default) |
| Registration Code | Auto-synced from the code shown on the virtual terminal display |
| Terminal Linking toggle | Auto-set based on the current linked/unlinked state of the simulator |
Click Link Terminal. The virtual terminal display will animate through the linking flow and show a confirmation. The Linked indicator in the simulator toolbar turns green.
Step 5 — Verify the Setup
After linking, confirm the following are all in order:
- Header shows Connected (SignalR live)
- Terminal Simulator toolbar shows Linked (green)
- ECR Simulator header shows the terminal ID badge (e.g.
80000800)
You are now ready to run simulated transactions. See the Integration Walkthrough for a complete payment flow.
Re-entering Credentials
To sign out and clear saved credentials, click Sign out in the sandbox header. You will be redirected to the sign-in page where you can enter new credentials.