Getting Started

Easily integrate VoguePay API to your platform using HTML Form, Notification/Order processing API, Mobile/Server-to-server API and Command API. Command API enables you to automate functions like bulk payment (this can be used for automate batch payment of salary without the hassle of manual processing).

The Test/Demo account set environment enables you to configure your account properly before going live with your transactions.

VoguePay Checkout

Simple HTML Form

Follow the steps below to manually integrate VoguePay into your website. When you're done, you will have added a VoguePay button and supporting code to your website so that customers can click to place orders through VoguePay.

We worked over the original Bootstrap classes, choosing a different, slightly intenser colour palette.

                        
                        <form method='POST' action='https://voguepay.com/pay/'>
                        <input type='hidden' name='v_merchant_id' value='qa331322179752' />
                        <input type='hidden' name='merchant_ref' value='234-567-890' />
                        <input type='hidden' name='memo' value='Bulk order from McAckney Web Shop' />

                        <input type='hidden' name='item_1' value='Face Cap' />
                        <input type='hidden' name='description_1' value='Blue Zizi facecap' />
                        <input type='hidden' name='price_1' value='2000' />

                        <input type='hidden' name='item_2' value='Laban T-shirt' />
                        <input type='hidden' name='description_2' value='Green XXL' />
                        <input type='hidden' name='price_2' value='3000' />

                        <input type='hidden' name='item_3' value='Black Noni Shoe' />
                        <input type='hidden' name='description_3' value='Size 42' />
                        <input type='hidden' name='price_3' value='8000' />

                        <input type='hidden' name='developer_code' value='pq7778ehh9YbZ' />
                        <input type='hidden' name='store_id' value='25' />

                        <input type='hidden' name='total' value='13000' />

                        <input type='image' src='http://voguepay.com/images/buttons/buynow_blue.png' alt='Submit' />

                        </form>
                        
                        

Sample HTML form 2

                        
                        <form method='POST' action='https://voguepay.com/pay/'>

                        <input type='hidden' name='v_merchant_id' value='qa331322179752' />
                        <input type='hidden' name='merchant_ref' value='234-567-890' />
                        <input type='hidden' name='memo' value='Membership subscription for music club' />

                        <input type='hidden' name='recurrent' value='true' />
                        <input type='hidden' name='interval' value='30' />

                        <input type='hidden' name='developer_code' value='pq7778ehh9YbZ' />
                        <input type='hidden' name='store_id' value='25' />

                        <input type='hidden' name='total' value='13000' />

                        <input type='image' src='http://voguepay.com/images/buttons/buynow_blue.png' alt='Submit' />

                        </form>

                        
                        

Sample HTML form 3

                        
                        <form method='POST' action='https://voguepay.com/pay/'>

                        <input type='hidden' name='v_merchant_id' value='qa331322179752' />
                        <input type='hidden' name='merchant_ref' value='234-567-890' />
                        <input type='hidden' name='memo' value='Bulk order from McAckney Web Shop' />

                        <input type='hidden' name='notify_url' value='http://www.mydomain.com/notification.php' />
                        <input type='hidden' name='success_url' value='http://www.mydomain.com/thank_you.html' />
                        <input type='hidden' name='fail_url' value='http://www.mydomain.com/failed.html' />

                        <input type='hidden' name='developer_code' value='pq7778ehh9YbZ' />
                        <input type='hidden' name='store_id' value='25' />

                        <input type='hidden' name='total' value='13000' />

                        <input type='image' src='http://voguepay.com/images/buttons/buynow_blue.png' alt='Submit' />

                        </form>

                        
                        

Sample HTML form 4

                        
                        <form method='POST' action='https://voguepay.com/pay/'>

                        <input type='hidden' name='v_merchant_id' value='qa331322179752' />
                        <input type='hidden' name='merchant_ref' value='234-567-890' />
                        <input type='hidden' name='memo' value='Bulk order from McAckney Web Shop' />

                        <input type='hidden' name='notify_url' value='http://www.mydomain.com/notification.php' />
                        <input type='hidden' name='success_url' value='http://www.mydomain.com/thank_you.html' />
                        <input type='hidden' name='fail_url' value='http://www.mydomain.com/failed.html' />

                        <input type='hidden' name='developer_code' value='pq7778ehh9YbZ' />
                        <input type='hidden' name='store_id' value='25' />

                        <input type='hidden' name='cur' value='USD' />

                        <input type='hidden' name='total' value='13000' />

                        <input type='image' src='http://voguepay.com/images/buttons/buynow_blue.png' alt='Submit' />

                        </form>

                        
                        

Mobile/Server-to-server API

Set up

To use voguePay on mobile or via server-to-server connection, you can get a link token for payment by sending your merchant ID and other necessary parameters in the format: https://voguepay.com/?p=linkToken&v_merchant_id=aaa&
memo=mmm&total=ttt&merchant_ref=rrr&recurrent=ccc&
interval=iii¬ify_url=nnn&success_url=sss&fail_url=fff&
developer_code=ddd&cur=ccc
where:
aaa is the Merchant ID
mmm is the Memo
ttt is the Total Cost
rrr is the Merchant Reference (Any value provided by merchant. his value will be returned with the confirmation results from the confirmation api. VoguePay doesnt need this value, it is used by the merchant to store any data he wishess to retrieve later with the transaction details.)
ccc is the Recurrent Billing status (true/false)
iii is the No of days between each recurrent billing if recurrent is set to true.
nnn is the Url to send payment notification to. If set, this will be used instead of the notification url on your account.
sss is the Url to send buyer back to if payment is successful. If set, this will be used instead of the Success Return URL on your account.
fff is the Url to send buyer back to if payment is unsuccessful. If set, this will be used instead of the Failure Return URL on your account.
ddd is the A code unique to every developer. Using this code earns the developer a commission on every successful transaction made through any selected integration methods.
ccc is the Currency code in which transaction would to be carried out.

Your merchant id, memo and total cost are required. All other fields are optional.
Response:
For a successful request, the api returns a url. Visting the url brings up VogiuePay payment page that can be used for payment based on the parameters supplied. The returned URL is valid for up to 24 hrs.
For failed requests, one of the following is returned:
-1 = Unable to process command
-3 = Empty Merchant ID
-4 = Memo is empty
-14 = invalid merchant id
-100 = No result
Example:
https://voguepay.com/?p=linkToken&v_merchant_id=qa331322179752&
merchant_ref=234-567-890&memo=Bulk+order+from+McAckney
+Web+Shop&total=13000&
notify_url=
http%3A%2F%2Fwww.example.com%2Fnotification.php& success_url=
http%3A%2F%2Fwww.example.com%2Fthank_you.html&
fail_url=
http%3A%2F%2Fwww.example.com%2Ffailed.html


Command API

Set up

The command API allows you to directly perfom several actions on VoguePay from your application.
The command API is in beta
With command API, you can:

fetch: Query our database for a list of transaction ids which can subsequently be processed with the notification API.
withdraw: You can make withdrawals to one or several bank accounts.
pay: You can transfer money to other VoguePay members.
create: You can create voguepay accounts for your members.

The Command API works for server-to-server communication.
The Command API can be consumed with the secure url:
https://voguepay.com/api


Notification/Order processing API

Set up

VoguePay sends a transaction id to the notification URL provided in your account for every transaction on that account.
To receive a transaction id on your success or failure URL, you must set Send Transaction ID to Success and Failure Return URL to Yes on your account preferences page.

The transaction ID is sent as a HTTP POST variable (transaction_id) e.g:
If your notification URL is http://mydomain.com/n.php
then notification will be sent to :
http://mydomain.com/n.php
You can retrieve it as a POST variable e.g $_POST['transaction_id'] for PHP.
You can confirm the status and details of a transaction anytime using our REST(ful) API below:
https://voguepay.com/
The api accepts parameters as a GET request. Below is a sample api call.
https://voguepay.com/?v_transaction_id=11111&type=xml

For demo transactions, use:
https://voguepay.com/?v_transaction_id=11111&type=xml&demo=true


Test/Demo Accounts

Set up

While integrating VoguePay, you may need a test account. We have provided a simple solution to test your integration.
Use demo as your merchant ID in test environment.
Once "demo" is used as your merchant ID, you can use any email and password to make payment.
To simulate a Failed transaction, use [email protected] with any password to pay for the transaction e.g: [email protected] or [email protected]
To simulate a successful transaction, use any email and any password to pay for the transaction. You may use your real email since a notification will be sent to the email address you use for the transaction.
The transaction ID will be sent to the notify_url parameter submitted by your form e.g:
value="http://www.mydomain.com/notification.php" />
You may then call the notification/order processing API from there.
For demo transactions, use add demo=true to the notification API as shown below:
https://voguepay.com/?v_transaction_id=11111&type=xml&demo=true