Run in Postman

Hit the 'Run in Postman' button above to fork our collection and interact with our API. View our Postman guide here.

The API is organised around REST. It allows you to seamlessly integrate your online payments directly into your website or app.

We provide a testing environment that enables you to build and test with the API without affecting live data or interacting with live banking environments.

In order to use the API, you will initially integrate into our test environment.

Once your account has been created, you will receive login credentials for the Hub, where you can access your app_id and app_key and get started with the API.

You can also use the portal, the Hub, to review and manage your transactions.

If you require access to our test environment, please contact [email protected].

If you have any questions about integrating with our API, please don't hesitate to contact us!

Getting started

To understand the API, a good starting point is to firstly read our Fundamentals documentation. This includes detail on authentication, error handling, statuses, reasons, pagination and testing.

All the endpoints of our APIs are documented within the API section. Here you will find extensive documentation including code examples and responses for each endpoint.

For further detail on how to implement our processes, there are many articles in the guides section of our documentation site.