Overview

Welcome to the Westpay Online API

The Westpay Online API enables merchants to integrate in-store payment processing directly into their point-of-sale systems. Using a simple REST interface, your application can send payment requests to Westpay terminals, handle refunds and reversals, manage terminal onboarding, and retrieve transaction reports.

Key Capabilities

• Payment Requests — Submit purchase, refund, reversal, and cancel requests directly to a payment terminal.
• Terminal Onboarding — Link and unlink terminals to your merchant account programmatically.
• Reporting — Retrieve the last transaction result and generate transaction reports for a given terminal.
• Metadata — Fetch configuration metadata including supported currencies, card types, and receipt formats.
• Receipt Printing — Trigger receipt printing on the terminal after a transaction.

How It Works

1. Your backend system sends a request to the Online API with the required parameters (amount, currency, terminal ID, etc.).
2. The API forwards the request to the physical payment terminal.
3. The terminal processes the payment (card tap/insert/swipe, PIN entry, etc.).
4. The API returns a response with the transaction result and a reference ID.
5. You can use the reference ID to retrieve the transaction status at any time.

Integration and Developer-Friendly

The Westpay AB Online API is designed with a focus on simplicity and ease of integration. Westpay AB provides comprehensive documentation, including detailed guides, code samples, and reference materials, to facilitate seamless integration with external payment processors. The API supports a range of programming languages and frameworks, empowering developers to utilize their preferred tools and technologies.

Scalability and Reliability

The Westpay AB Online API is built on a scalable and reliable infrastructure to accommodate businesses of all sizes and transaction volumes. The API leverages robust servers, load balancing techniques, and fault-tolerant architecture to ensure high availability and minimal downtime. This allows businesses to handle peak transaction loads without compromising on performance.

Westpay AB maintains a proactive monitoring system to promptly identify and address any potential performance or availability issues. By continuously optimizing the infrastructure and closely monitoring the API, Westpay AB guarantees a reliable and seamless payment experience for businesses and their customers.

Base URL

All API requests are made to the following base URL:

https://api.westpay.se/in-store/api/v1

For the demo environment, use:

https://demo-api.westpay.se/in-store/api/v1

Authentication

All requests must include:

• Authorization header: Bearer <access-token>
• Ocp-Apim-Subscription-Key header: <merchant-subscription-key>

Refer to the Getting Started guide for details on obtaining credentials.