Integrate Real Commerce into your App

Easily connect your agents and customers to the value chain of leading FMCG suppliers in your territory. You'll find comprehensive guides and documentation to help you start working with the ShopTopUp CommerceAPI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Registration Parameters

You need to register as a partner on ShopTopUp before you can integrate the plugin

Before you can successfully install and use the ShopTopUp plugin on your app, you will be required to register your business as a Partner on the ShopTopUp platform.

This will give you access to your API key which you will be required to use to complete any order on ShopTopUp.

The following details are required:

1. Business Name

This is the name associated with your business (agent network, financial institution, chain, etc). It is what your business is called and not the name of the individual agents that you will be creating

📘

Important

Business name should be in the following format:
"businessName": "my business name"

2. Email

This is the email address associated with your business. It is where we will send all important email notifications to in order to alert you on actions performed using your API key

📘

Important

Email should be in the following format:
"email": "[email protected]"

3. Phone Number

This is the phone number associated with your business. SMS notifications can be configured and will be received via this phone number

📘

Important

Phone number should be in the following format
"phoneNumber": "07064215065"

4. Password

This will be the password that you will use to log into your Partner Dashboard in order to view order details and information on all your registered agents using the ShopTopUp service

📘

Important

Password should always be in this format
"password": "xxxxx"

5. Address

This is the address of your business. We use this to track information on Partners within our scheme

📘

Important

Address should always be in this format
"address": "3 Akini Road, Sangotedo, Lagos"

6. Country Code

This is the country where your business is located.

📘

Important

Country code should always be in this format
"countryCode": "NG"

Updated about a year ago


What's Next

Registering Yourself as a Partner or Super Agent

Register & Fetch Your API Key

Registration Parameters


You need to register as a partner on ShopTopUp before you can integrate the plugin

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.