Welcome to our support center

Developers


The Payment Page

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


API Key and Merchant ID

The API key is used to authorize calls to the server and help identify who is making these requests. As part of every request this key will be required, alongside your supplied merchant ID. It is essential that the API key is secured is and is not shared with anyone else. You will see the instructions below on how to find these two values.


How to test without an Account

You can have a taste of Swipe before signing up and creating a merchant account with Swipe. In this document you will find a set of working examples under each heading. These are pointed to a test area of the website in which no transactions will be submitted online or processed. The responses are solely dependent on that one request and no information will be stored on the server.


Setting Up A Development Account

If your merchant already has already signed up with Swipe, you can still test the Swipe services by setting their account in development mode (you can sign up through our website http://www.swipehq.com). As their developers, you are able to integrate our services using example credentials and then carry out any test transactions at no cost or obligation. These transactions are only for test purposes so any transactions that are made at this mode will not be set live and transacted through.


Live Payment Notification (LPN)

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Changing LPN & Callback Settings

LPN and Callback settings are used to inform the calling server that the transaction was successful, as well as provide redirection back to the originating page after the transaction has been completed.


API Overview

Swipe offers powerful custom behaviour through API calls.


Create Transaction Identifier

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Create Subscription Identifier

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Verify Transaction

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Product APIs

The Product API system can be used to dynamically fetch, create and update products in the Swipe Checkout system. This is useful if a product database exists, and needs to be transferred to Swipe Checkout.


Fetching Products

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Creating Products

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Updating Products

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Subscription & Contract APIs

There are two types of subscription contracts in the Swipe system. These are template subscription contracts and active subscription contracts. Template subscription contracts are template subscriptions that hold all the subscription information, such as recurring price, duration and terms and conditions. When a subscriber signs up to a subscription, Swipe copies the data out of a subscription template, and creates a new 'Active' subscription contract.


Fetching Contracts

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Creating Contracts

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Suspending Contracts

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Updating Contracts

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Updating credit card Information

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Tokenization

The tokenization API is used to securely store and charge credit cards, this allows you to implement your own customized billing systems.


Creating Tokens

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Charging Tokens

This section expects prior knowledge and understanding from the sections indicated below. Please note that these areas are essential to obtaining a successful response and notifying your server upon completion.


Supported Shopping Carts

Please check this link to find out more information.


Available Currencies

You will find a list of the supported currencies below. Payments can be accepted in only NZD or alternatively expanded to accept a range of currencies.


API Response Format

All Swipe API's return a standardized JSON object based format