Welcome to Tapway! In this documentation you'll find everything you need to integrate with Tapway and our API. We hope this is as user-friendly and simple to follow as possible, but if you have any questions, please send us a mail.
The quickest way to get your integration up and running is to use our Quickstart guide, which covers the entire step-to-step integration for Tapway. You can integrate Tapway into your site or app and use any client libraries to get the data you need from our API.
curl --location --request POST 'http://localhost:4020/api/merchant/register' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6ImFjY2VzcyJ9.eyJpYXQiOjE1OTgxMzU1OTMsImV4cCI6MTYyOTY5MzE5MywiYXVkIjoiaHR0cHM6Ly95b3VyZG9tYWluLmNvbSIsImlzcyI6ImZlYXRoZXJzIiwic3ViIjoiNWYxOGM0Yjg1YjJmNzI3ZWRiMjlhNWExIiwianRpIjoiMjM4NDEzYzUtNzZhYi00NzkwLTljYzktODNjOGZjN2EyYTk4In0._NPdM_0Zg-N2kqNlkJjbiNJ06VgIeKggDCKDsnuThDM' \--data-urlencode 'address=No 45, Freedom way Lekki' \--data-urlencode 'contactName=Morgan Freeman' \--data-urlencode 'contactNumber=08065230878' \--data-urlencode '[email protected]' \--data-urlencode 'name=Freeman Ltd' \--data-urlencode 'state=Lagos' \--data-urlencode 'lga=Eti-Osa'
Register as a Merchant a. Signup b. API key is generated
Register customers a. Sign up a customer b. Verify Customer Sign up
Requests a. Create a delivery request b. Track Delivery Request
Orders a. Track Orders
Transaction History a. View transaction history by date, customer or order
a delivery request made by a customer
A delivery request that has been assigned to a dispatch rider
a public API identifier; used to initialize Tapway and identify Records you create or update via Tapway
The Tapway API uses POST and GET requests to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON. The Tapway API is served over HTTPS TLS v1.1+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.1 are not supported. All requests must include a Content-Type of application/json and the body must be valid JSON.
Our Sandbox environment is unrestricted and supports only test Records. All testing should be done in the Sandbox environment. All activity in the Production environment will be billed.
We periodically release new, dated versions of the API whenever we make breaking changes. The current version is
We strive to avoid making any breaking changes to our API, but we do make changes over time that may result in changes to the data that you get from Tapway.
We consider the following changes to be backwards compatible:
Adding new API endpoints
Adding new options parameters to existing endpoints
Adding new data elements to existing response schemas
Adding new error_types and error_codes
Adding new webhook_types and webhook_codes
Changing the length or content of any API identifier