Link to deployed version of this app
The Online Payments API allows you to accept web payments across a variety of regions and countries. Various payment methods are supported depending on your business and how your customers expect to pay. We will be adding more use cases so you can get an idea of how to use these flexible APIs to meet your specific business needs.
You can:
- Spin-up a sample application with UI that demonstrates the main use case for each endpoint. For example, authorizing a payment.
- Explore the API resources using a Postman Collection.
There are two main directories for you to access:
/app
for the showcase UI./postman
for the Postman Collection./docs
for documents supporting the testing and usage of the apis.
A TS/JS application with a client used to demonstrate how to integrate with our APIs on frontend applications.
All your actions on this application are served by mock data included in the app codebase.
Get straight to the API endpoints in action, make calls and see responses. To use the Postman collection, import the collection file to Postman and follow the included setup instructions to access all possible calls to the Online Payments API. You will need certificates to run these calls.
This is the core UI application written in TS/JS with the React framework. This application illustrates the various capabilities of Online Payments API, using mocked responses stored within the codebase.
We have created capabilities for all Online Goods and Services using our API such as:
- Authorizing a payment
- Capture a payment
- Full
- Partial
- Multi Capture
- Refund a payment
- Full
Check out the features directory to explore the the components and hooks that use these features.
Install and run a TS/JS application with a client used to demonstrate how to integrate with our APIs on frontend applications.
This example requires Yarn.
To start our client code with mocked responses:
-
Clone this repo.
-
Install the
client
folder:
cd app
cd client
yarn install
- Start the UI:
yarn start
- Open a browser and navigate to the locally deployed app using the URL provided in the command line. Usually
localhost:3000
.
You have deployed the showcase Online Payments app. Follow the onscreen instructions to explore the banking functionality available.
You will see in this showcase that we are currently mocking the server responses using MSW. You will still be able to see the request in the network tab of your browser developer tools.
You can ignore the code stored in the data, mocks and mockServiceWorker folders as this only relates to our mocking services.
If you would like to try out our APIs you can use our postman collection provided in this repository or follow the quick start guide here.