VdsPay API Documentation

Getting Started

This document will show you how to get up and running with VdsPay. The API is a comprehensive and RSESTFUL HTTP API that enhances communication between your application and vdspay

Transactional Queries

Account Queries

Other Instructions

For additional support, please email Acquiring@vds.com.ng


Integrating VdsPay with an existing website is easy and can be achieved with simple steps.

At a high level you want to achieve the following:

  • ** POST transaction details to Obtain Authorization URL
  • ** Calculate a request hash to ensure transaction integrity
  • ** Provide a URL which VdsPay would post back the authorization response
  • ** Query the transaction details directly from VdsPay to ensure the actual transaction amount was approved

The only requirement is to POST transaction data to the VdsPay server via JSON API. The section below describes how to create this POST with cURL.

Heads up!

You can now use the demo merchant details provided here to start testing your code and integration immediately without completing the sign up process.

curl https://acs.vds.com.ng/transaction/auth \
-H "Authorization: Merchant HASH_KEY" \
-H "Content-Type: application/json" \
-d '{"transaction":{"accountNo":"0688258274","memo":"Payment For 1 Book","reference":"029882","amount":"100","currency":"NGN","type":"sale","return_url":"https://mywebsite.com/thanks.html","notify_url":"https://mywebsite.com/notify.aspx","customer":{"name":"Martin Luther","email":"martinluther@testmail.xxx","phone":"+448002566955"}}}' \

To calculate the HASH_KEY, its the sha512 hashing of accountNo, reference, amount and API Key. Your Merchant API Key will be issued to you.

Result Format

  "status": true,
  "message": "Authorization URL created",
  "data": {
    "authorization_url": "https://acs.vds.com.ng/vpc/0peioxfhpn",
    "access_code": "0peioxfhpn" } }


A deprecated integration in HTML is available for soft programmers. WE DO NOT RECOMMEND THIS!

<form class="form-horizontal" role="form" method="POST" action="https://acs.vds.com.ng/webscr/?cmd=_pay" target="_top">
  <input type="text" name="customer_phone" value="2340000000000">
  <input type="hidden" name="ref_code" value="0000000">
  <input type="hidden" name="memo" value="Transaction Testing"/>
  <input type="hidden" name="return_url" value="https://mywebsite.com">
  <input type="hidden" name="tn_type" value="sale">
  <input type="hidden" name="acct_number" value="00000">
   <input type="hidden" name="amount" value="100.00">
<input type="hidden" class="form-control" name="customer" value="John Doe">
      <input type="hidden" name="customer_email" value="shshs@ok.k">
      <select name="currency">
      <option value="NGN">NGN</option>
      <button type="submit" class="btn btn-default">Submit</button>

Auth Request Parameters

Here are the JSON parameters for generating Authorization.

Param Description
accountNo Your Merchant Account Number. This is not Merchant ID.
memo The Title Of the Order. E.g Payment for Shirt
reference This is required. A Reference Number sent by the Merchant to identify transaction
amount The amount to be paid.
currency payment currency – should be 3-letter ISO_4217
type The is usually ‘sale’. However, it can be AddFund or Subscription but be careful choosing this. Use Sale if you do not understand.
return_url This is the URL the gateway redirects to after payment. Whether or not the payment was successful
notify_url This is the URL where messages will be sent instantly upon a payment.
Read the Docs v: latest
On Read the Docs
Project Home

Free document hosting provided by Read the Docs.