{"info":{"_postman_id":"8db6c949-b1b0-48d6-8774-589851848df3","name":"wiGoPay API Developers ","description":"

Introduction

Welcome to wiGopay! In this release, we have developed simple and secure paymnet gateway that will enable you receive payment online this can be websites, mobile apps, USSD app using M-Pesa and Cards.\nWe have two types of intergrations:-

1. Web based integration
2. REST API Integration

\n\n

Web Based Integrations

Customer checks out from merchant website and selects wiGopay as the preferred payment method
Customer is redirected to the wiGopay payment gateway where they will be presented with an interface containing the various payment channels.
The customer selects mode of payment, follows the instructions and pays.
If the transaction has successfully been processed customer is redirected to the merchants website through Callback URL.\nDuring the redirected wiGopay send payment status to Callback URL

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1271703","collectionId":"8db6c949-b1b0-48d6-8774-589851848df3","publishedId":"SW17SvD4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-07T14:08:45.000Z"},"item":[{"name":"Web Integration","item":[{"name":"Checkout ","id":"329949ca-6115-4972-8d04-d58ae59dde92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"description":"

merchant Code assigned by wigoPay.(UPPERCASE ACCEPTED ONLY)

\n","key":"mc","type":"text","value":"test67"},{"description":"

LIVE or DEMO mode (1 or 0). “1” By Default (live)

\n","key":"live","type":"text","value":"1"},{"description":"

Customer name

\n","key":"cn","type":"text","value":"James Mwangi"},{"description":"

Customer email addresss

\n","key":"eml","type":"text","value":"john@email.com"},{"description":"

Customer Telephone number

\n","key":"tel","type":"text","value":"254722705138"},{"description":"

Currency Type (KES) * KES By Default

\n","key":"c","type":"text","value":"KES"},{"description":"

Order Reference or OrderID

\n","key":"oref","type":"text","value":"11"},{"description":"

This parameter holds the value of the URL on your server to which wigoPay will send back payment status.

\n","key":"cb","type":"text","value":"http://examplecallback.com"},{"description":"

Order total amount (DO NOT PASS any commas as a thousands separator). e.g. amt=1234.00 and NOT amt=1,234.00

\n","key":"amt","type":"text","value":"1"},{"description":"

Hash Code provided by wigoPay

\n","key":"hsh","type":"text","value":"e8e66bedc4826ead9fb41d09aef8ebc2c13f27c1"},{"description":"

Optional field. allows sending & receiving your custom variables

\n","key":"v1","type":"text","value":""},{"description":"

Optional field. allows sending & receiving your custom variables

\n","key":"v2","type":"text","value":""}]},"url":"https://gateway.wigopay.com/","description":"

Generate Hash Variable

We need to generate the hash signature id that is to be sent to the wigoPay system for authentication against the transaction values that are also to be received on the same URL call.

\n\n

We are using the hash_hmac function in PHP to digitally sign the transaction data.

\n\n

Here is a PHP example below: There are two important parameters that are required by this function.

The string to be hashed - $datastring - this string is composed of SELECT the parameters you are passing to wiGopay in the following CONCATENATED format. The order of the transaction variables is VERY IMPORTANT and MUST be followed. There are NO SPACES between the different values below.

\n\n

Sample PHP hashing

\n$datastring =  $fields['live'].$fields['oref'].$fields['amt'].$fields['tel'].$fields['eml'].$fields['mc'].$fields['curr'].$fields['v1'].$fields['v2'].$fields['cb'];\n$hashkey =\"\";
\n$generated_hash = hash_hmac('sha1',$datastring , $hashkey);\n

\n
\n
\n

use \"demo\" for testing where mc also is set to \"demo\"

\n\n","urlObject":{"protocol":"https","path":[""],"host":["gateway","wigopay","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"329949ca-6115-4972-8d04-d58ae59dde92"},{"name":"HTTP Call back response / Return URL","id":"5a75fe82-d999-4066-b908-594252c8f8b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"www.store.com/returnpage","description":"

These variables will be sent back to your website via your return URL, using the GET method after successful payment.

\n\n

oref=11 : Order Reference or OrderID passed at checkout.

hsh=aei7p7yrx4ae34 :generated hashed form concatinated string oref and vendors code.

\n\n

\n$data_string=$oref.$vendocode
\n$generated_hash = hash_hmac('sha1',$datastring , $hashkey);\n

example of return url

\n\n

www.website.co.ke/returnpage/?oref=23&hsh=aei7p7yrx4ae34

\n","urlObject":{"path":["returnpage"],"host":["www","store","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a75fe82-d999-4066-b908-594252c8f8b9"},{"name":"Payment Verification","id":"a520d7da-bcf7-4c09-ac16-28d3529d528a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://end.wigopay.com/api/callback/ipn?oref=19&hsh=aei7p7yrx4ae34","description":"

The variables that wiGopay returns on Callback :

(a) The status variable has the following possible values:-

ccc0377a8afbf50e7094f5c23a8af223 = Failed transaction. Not all parameters fulfilled. A notification of this transaction sent to the merchant.

\n\n

c4812ee2b789226193ad2511495fa559 = Success: The transaction is valid. Therefore you can update this transaction.

\n\n

c69f06e1a9b016d133907b4e5f5864d2 = Pending: Incoming Mobile Money Transaction Not found. Please try again in 5 minutes.<.p>\n\n\n

(b) oref =order Reference or orderID.

\n","urlObject":{"protocol":"https","path":["api","callback","ipn"],"host":["end","wigopay","com"],"query":[{"key":"oref","value":"19"},{"key":"hsh","value":"aei7p7yrx4ae34"}],"variable":[]}},"response":[],"_postman_id":"a520d7da-bcf7-4c09-ac16-28d3529d528a"}],"id":"58d37c1c-6010-42bb-a7d3-95d7ebf93424","event":[{"listen":"prerequest","script":{"id":"ad13157f-531b-4ec8-985e-bdb56b9975c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ce5437a-f6df-4a41-9434-a33e6c56b714","type":"text/javascript","exec":[""]}}],"_postman_id":"58d37c1c-6010-42bb-a7d3-95d7ebf93424","description":""},{"name":"Rest API","item":[],"id":"2af23f75-15c4-4501-83e0-44510f24de9b","description":"

Coming soon

We are working hard to release it by November 2019.

","_postman_id":"2af23f75-15c4-4501-83e0-44510f24de9b"},{"name":"WiGoPay Wallet","item":[],"id":"565aca8e-9bb0-4600-8e9b-0f93f05dc261","description":"

COMING SOON

","_postman_id":"565aca8e-9bb0-4600-8e9b-0f93f05dc261"},{"name":"Bill payments","item":[],"id":"53fd03f2-4cc7-4eda-b3e1-e942202ba549","description":"

COMING SOON

","_postman_id":"53fd03f2-4cc7-4eda-b3e1-e942202ba549"}],"event":[{"listen":"prerequest","script":{"id":"211145f5-e2a4-4c7f-bf5b-a1763ac7ef4a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9510bcdb-75ac-4d75-af50-682069d32356","type":"text/javascript","exec":[""]}}]}