Terminal Service

Number of APIs: 30

Welcome to the Azapay Terminal Request Service API Documentation. This guide provides information on accessing and utilizing Azapay's Terminal Request Service to manage terminals and their transactions for business.

Getting Started

Before using the Terminal Request Service API, ensure you have:

• Log in to your Azapay Dashboard to create an API Key and get your Business ID.

These credentials are important for authenticating your requests and should be passed as request headers in the following format: Api-Key and Business-Id.

The Terminal Request Service API is segmented into four main parts:

1. Terminal Branch Location

2. Terminal

3. Terminal Banks

4. Terminal Transactions

Here are the Testing and Production URLs:

• Testing URL: https://terminal-service-api.open.azapay.ng/

• Production URL: https://terminal-service-api.azapay.ng/

When integrating, you’re to follow these steps in order

1.⁠ ⁠Create Terminal Branch Location (terminal has this a dependency)
2.⁠ ⁠⁠Create Terminal (You can see this as a virtual POS Terminal Device)
3.⁠ ⁠⁠Create Terminal Banks (These are real bank accounts that can be attached to terminals)
4.⁠ ⁠⁠View transactions.

Understanding How Filter Data

You may want to filter data from any of our endpoints, to understand how to do that [click here]

1. Terminal Branch Location - Create Terminal Branch Location POST {{terminal-service-api}}/terminal-branch-location/create

2. Terminal Branch Location - Get Allowed Search Conditions GET {{terminal-service-apil}}/allowed-query/search-condition

3. Terminal Branch Location - Get Allowed Search Fields GET {{terminal-service-api}}/allowed-query/fields/terminal-branch-location

4. Terminal Branch Location - Get Single Terminal Branch Location GET {{terminal-service-api}}/terminal-branch-location/details/{{terminal-branch-location-id}}

5. Terminal Branch Location - Get All Terminal Branch Locations GET {{terminal-service-api}}/terminal-branch-location

6. Terminal Branch Location - Get All Terminal Branch Locations (using POST) POST {{terminal-service-api}}/terminal-branch-location

7. Terminal Branch Location - Update Terminal Branch Location PUT {{terminal-service-api}}/terminal-branch-location/update/{{terminal-branch-location-id}}

8. Terminal Branch Location - Delete Terminal Branch Location DELETE {{terminal-service-api}}/terminal-branch-location/delete/[REPLACE_WITH_YOUR_ID]

9. Terminal - Create Terminal POST {{terminal-service-api}}/terminal/create

10. Terminal - Get Single Terminal GET {{terminal-service-api}}/terminal/details/{{terminal-id}}