Command API
Perfom several actions on VoguePay from your application without visiting your VoguePay Account/Dashboard.
The command API allows you to directly perform several actions on VoguePay from your application.
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.
The Command API works for server-to-server communication.
The Command API can be consumed with the secure url:
The command API accepts json, xml, yaml or ini formated parameter via HTTP POST. Your query should conform to the format specified below.
Key | Value |
task | fetch or pay or withdraw(Required) |
merchant | Your VoguePay Merchant ID (Required) |
ref | Unique id for each request (Required) |
hash | Required Security code generated by concatenating the following and passing the result through a sha512 encryption your command api token task specified above your voguepay email ref specified above |
list | Used as a parent container for non-fixed key/value pairs where multiple requests are made in a single call |
id | unique ID for each item in a list if multiple requests are made in a single call |
Response
Command API returns the result as key/pair values in the format that it receives them (json, xml, yaml or ini).
The fields returned as explained below:
Key | Value |
id | The original ID submitted for each item in a list of multiple items |
username | Username of the merchant on voguepay is returned |
salt | String used for calculating the returned hash code |
hash | Security code for verifying the authenticity of the result. Generated by concatenating the following and passing the result through a sha512 encryption your command api token your voguepay email salt specified above |
list | Used as a parent container for status, response, values and description where multiple requests are made in a single call |
status | OK for successful operations or FAIL for unsuccessful operations |
response | OK = successful operation X001 = Invalid Merchant ID X002 = Invalid Reference X003 = Invalid hash X004 = Invalid task X005 = Invalid Merchant ID X006 = Invalid hash C001 = Unauthorised access C002 = Invalid Email C003 = Invalid username C004 = Invalid phone number C005 = Invalid firstname C006 = Invalid lastname C007 = Invalid country C008 = Unable to create member C009 = Currency not supported by country provided C010 = Password must contain at Least one numeric value (0-9), one Uppercase, one Lowercase and one special character C011 = Invalid Currency W001 = Invalid amount W002 = Operation Failed. W003 = Amount is below minimum allowed W004 = Insufficient balance W005 = Withdrawal failed W006 = Withdrawal failed P001 = Invalid amount P002 = Operation Failed. P003 = Seller and buyer are one and the same P004 = Invalid beneficiary P005 = Invalid memo P006 = payment amount is below minimum allowed P007 = payment amount exceeds maximum allowed P008 = Insufficient balance for payment P009 = Payment failed P010 = Payment failed P011 = Payment failed WL000 = System error WL001 = Invalid Parameters WL002 = Validation Error WL003 = Transaction Request Declined WL004 = Currency is not allowed WL3D = 3D Authorization required |
values | Comma separated transaction IDs |
description | Description of the response |
Download sample PHP files for command API implementation below:
Last updated