SnapScan Developer API

Welcome to to the SnapScan Developer API documentation! Here you‘ll find everything you need to know about integrating with our API, including authentication, endpoints, and best practices for building with SnapScan.

Get startedWebsite
api-service.js
package.json
// API Base URL
const baseUrl = 'https://pos.snapscan.io/merchant/api/v1';


async function fetchMerchantData() {
  try {
    const response = await fetch(baseUrl);
    
    if (!response.ok) {
      throw new Error('HTTP error!', response.status);
    }


    const paymentData = await response.json();


    console.log('Payment Data:', paymentData);


  } catch (error) {
    console.error('Fetch error:', error.message);
  }
}


fetchMerchantData();

Introduction

Overview

The SnapScan API is REST-like and relies on HTTP status codes to indicate API errors. We support CORS so that you can interact with our API through a client-side web application. We return JSON in all responses from the API.

API Overview

Authentication, error codes, pagination and webhooks

QR Codes

How to generate QR codes and their URL structure

Payments

Query the status of payments that were made against your merchant account.

Cash ups

Mark the end of your transaction period and query all payments completed within the associated period

WooCommerce, Magento, ShopStar, OpenCart and PayGate integrations available. We also offer a partial integration with Shopify. Please contact help@snapscan.co.za for more information.

TLS Update

As of 17 May 2021 we will no longer support TLS 1.0 or TLS 1.1 over HTTPS. Any older web views or API clients that do not support TLS 1.2 or higher will no longer work.

Next
Authentication