Redde Merchant Checkout Documentation

Checkout that simplifies the way your customers pay money on your platforms.

Welcome to Redde's Checkout Docs

Redde is a system that allows merchants to receive payments for goods and services. You can use the Redde portal to sweep your money into your bank account. Transactions via Redde happen online via a web browser or our Redde app available for iOS, Windows. And Android.

Redde provides a secure, easy and convenient method of making online payments for products and services.

Instructions

API Key:

Before you can have access to APIs you need to register and create an Account. Header for all request should have {"apikey": "string"}: and this API key will be sent to merchant when their app configuration is setup for them by Wigal.

Approval

One will be given access to modify their API callbacks once they are approved to do so. To be approved, one needs to upload their Genuine details to the Account Profile Section under the Account Page. And complete the Business Information and contacts, Primary Contact Person and Documentation pages. Upon successful review by the Redde Team, approval will be granted.

Status Responses:

For more information on status response check it out on the Rest API Docs page

Supported Channels

  • MTN
  • AIRTELTIGO
  • VODAFONE
  • MASTERCARD
  • VISA

Callbacks

You need to setup your callback URL for the apps we create for you on Redde

  • 1. Login to your Redde account
  • 2. Click on the Apps link on the navigation bar
  • 3. You will see your list of apps in a table. Click on the modify button
  • 4. Add your callback url(s) for both the Receive Callback URL and Cash Out Callback URL
  • 5. Apply changes and you are all set.

Customer API (Checkout)

Initiate an online checkout by Merchant

Gather amount and description from client or customer on your site where you have implemented the Redde Checkout and set your site details

Endpoint: POST
                            
                                https://api.reddeonline.com/v1/checkout/
                            
                        

Header data
Field / Parameter Value Required Description
Content-Type application/json;charset=UTF-8 Yes this is needed to encode to UTF-8
Payload description
Field / Parameter Type Required Description
apikey string Yes will be given by wigal when the app is setup
appid characters Yes will be given by wigal when the app is setup
amount number Yes Amount of items purchased
description string Yes Description of items purchased
logolink url Yes Merchant's logo for displaying on checkout page
merchatname string Yes Merchant's name for displaying on checkout page
clienttransid string Yes Transaction id generated by Merchant to check client's payment transactions
successcallback url Yes A callback url to redirect client when payment transaction has been successful
failurecallback url Yes A callback url to redirect client when payment transaction has failed
Sample Payload:
                                

                                    Payload:
{
"amount": 10,
"apikey": "XXXXXXXXXXXXXXXXXXXXXXX",
"appid": XX,
"description": "Buying something from Merchant Name Limited",
"failurecallback": "https://www.example.com/failure",
"logolink": "http://example.com/logo.png",
"merchantname": "Merchant Name Limited",
"clienttransid": "102474",
"successcallback": "https://example.com/success"
}

                                
                            

Sample Response: Checkout Initiation

After a successful initiation a checkout url will be given for transaction to be processed. Merchant will have to redirect client this url.

                                
									
Response: Success Initiation
{
"status": "OK",
"reason": "Checkout Initiation accepted",
"referenceid": "102474",
"responsetoken": "M7M9yLhyKa18q4JjAOisXmaZ+PaTuOTUouYDdXnSQq4=",
"checkouturl": "https://checkout.reddeonline.com?token=M7M9yLhyKa18q4JjAOisXmaZ%2BPaTuOTUouYDdXnSQq4%3D",
"checkouttransid": 54
}
                                
Response: Failure Initiation
{
"status": "FAILED",
"reason": "APP ID:1 cannot be found",
"referenceid": null,
"responsetoken": null,
"checkouturl": null,
"checkouttransid": null
}

                                
                            


Check status of checkout transaction with ID
Endpoint: GET
                            
                                https://api.reddeonline.com/v1/checkoutstatus/{checkouttransid}
                            
                        	

Header data
Field / Parameter Value Required Description
apikey xxxxxxxxxxxxxxxxxxxx Yes merchant api key given to you by wigal
appid xx Yes merchant app id given to you by wigal
Content-Type application/json;charset=UTF-8 Yes this is needed to encode to UTF-8
Url Parameter
Field / Parameter Value Required Description
checkouttransid number Yes transaction id from checkout initiation

Sample Response for checkout transaction status
                                

Response:
                                    
{
"status": "PAID",
"reason": "Successfully processed transaction.",
"transactionid": 414494,
"clienttransid": "102486",
"clientreference": "REDDE-CHECKOUT-72",
"statusdate": "2019-05-15 12:02:13.732",
"brandtransid": "5865016103"
}
                                
                            


End of Checkout API