@valueswitch







Introduction

ValueSwitch is a turnkey alternative payment solution provision company with prime expertise in Customizations, third party payment service, automated mass disbursements through API- web services and a host of other voucher based financial exchange services.

We have various channels through which services are delivered namely:

  • Web API - For third party connectivity and integration
  • SMS Services

Web API

ValueSwitch has provided needed functions to enable ValueSwitch services consumed on 3rd party environments / apps. The APIs are used to process payments using ValueSwitch Cash Tokens or from ValueSwitch wallet.

Developers can access these functions using http protocol.

Before you can start integrating ValueSwitch, you will need a ValueSwitch account. Create a free account now if you haven't already done so – https://valueswitch.com.ng/SignUp.aspx . After successful activation of the account, you need to apply for your API key within your profile dashboard.

Test URL: https://valueswitchtest.azurewebsites.net

Live URL: https://valueswitch.com.ng

Authentication

Get AccessToken

ValueSwitch uses Member ID, Username, api key and Secret to allow access to the API. You can register to get your api key and secret at our ValueSwitch Portal. The api key and secret would provide an authorization token which would now grant you access to all our ValueSwitch endpoints.

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetAccessToken 
Method: POST
Query Parameters
Parameters
Type
Description
MemberID
String
Your Platform unique Identifier (Not phone No)
Username
String
Username entered when creating API key
Password
String
Password provided when creating API key

Result Sample: 

Wallet Balance

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetWalletBalance 
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication 
MemberID
String
Your Platform unique Identifier (Not phone No)
LoginID
String
Phone No registered to the account

Result Sample: 

Wallet Funding

Fund With CashToken

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?TopUpWeb  
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication 
MemberID
String
Your Platform unique Identifier (Not phone No)
TokenID
String
CashToken presented for which value is to topup wallet
LoginID
String
Phone No registered to the account

Result Sample: 

Transaction charge: N80

Payments

Pay With CashToken

This enables business owners and individuals receive payment for service using ValueSwitch CashToken as payment medium for the exchange.

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?PaymentWithToken 
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
TokenID
String
CashToken presented for payment
InvoiceID
String
Your Transaction reference to Identify transaction
InvoiceAmount
Double
Transaction Amount
PayerPhone
String
Phone number of the Payer(Payment initiator)

Result Sample: 

Transaction charge: N50

Pay With Wallet

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?PaymentWithWallet 
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
WalletLoginID
String
PhoneNo used to register the account
WalletPass
String
Wallet password
PaymentValue
Double
Transaction Amount
YourReference
String
Your Transaction reference to Identify transaction

Result Sample: 

Transaction charge: N50

Wallet to Wallet Transfer

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?WalletTransfer   
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
RecipientWalletID
String
Wallet ID of the recipient (Not Phone No)
TransferValue
Double
Amount of Units to transfer

Result Sample: 
Transaction Cost: 50

Payment History

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetPaymentHistory  
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
fromDate
String
Start date of payment (mm-dd-yyyy)
endDate
String
End date of payment (mm-dd-yyyy)

Result Sample: 

Payment Details

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetPaymentDetailsByPayerID   
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
PayerID
String
Start date of payment (mm-dd-yyyy)

Result Sample: 

Send Wallet Value to Bank

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?SendWalletValueToBank   
Method: POST
Query Parameters
Parameters
Type
Description
accesstoken
String
Token generated during authentication
MemberID
String
Your platform unique Identifier
Amount
Double
Amount of Units to send to Bank

Result Sample: 

Transaction Cost: 50 <= N5000, 1.4% > N5000 (N50 is charge for Transaction value below 5000 while 1% is charged for transactions above N5000)

Cash Token s

Generate Single Token

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GenerateSingleToken   
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
TokenValue
Double
True
Value of the Token
ExpiryDate
Date

            
Date of Expiration of the token

Result Sample: 

Generate Multiple Tokens

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GenerateBulkTokens    
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
No_Tokens
Integer
True
No of tokens to be generated
TokenValue
Double
True
Value of each tokens
ExpiryDate
Date

            
Date of Expiration of the token
ChargeOption
integer
True
1 – Generator will bear charge, 2 – Recipient will bear charge

Result Sample: 

Cash Out Activities

Verify TokenID

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?VerifyCashToken    
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
TokenID
String
True
Token digits 

Result Sample: 

Automate a Payment – Recurrent Payment

Authority Token

This is used to grant approval for a direct debit of payment from ValueSwitch Wallet

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GenerateAuthorityToken    
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
PayerID
String
True
Token digits 
TransType
String
True
Either Web Payment Or Service Payment
PaymentDesc
String
True
Description of Payment
PaymentValue
Double
True
Amount
Email
String
True
Email of Beneficiary
DaysInterval
Integer
True
No if days to the next debit

Result Sample:

Automate Payment

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?AutomatePayment    
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
AuthorityToken
String
True
Token digits 
YourRefID
String
True
Either Web Payment Or Service Payment

Result Sample:

Donations

ValueSwitch also provided convenient channel for donation collection as part of its service offering

Donation Balance

Get Donation Balance on Donations created under your profile.

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetDonationBalance     
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
DonationID
String
True
ID generation for Donation via ValueSwitch Platform under your profile

Result Sample: 

Donation History

Retrieve list of Payment history on a Donation. 
http Request: https://valueswitch.com.ng/api/WebPayments.asmx?GetDonationHistory      
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
DonationID
String
True
ID generation for Donation via ValueSwitch Platform under your profile

Result Sample: 


Make Donation

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?ReceiveDonation      
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
DonationID
String
True
ID generation for Donation via ValueSwitch Platform under your profile
TokenID
String
True
Voucher whose value is to be donated
DonorName
String
True
Fullname of the donor
DonorEmail
String
True
Email Id of the donor
DonorPhone
String
True
Phone no of the donor

Result Sample: 

Airtime Purchase

Send VTU Airtime(mtn, globacom,airtel and 9mobile) to Various Recipients through WalletBalance

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?AirtimeTopup     
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
NetworkType
String
True
Either mtn, airtel, globacom and 9mobile
TransValue
Double
True
Amount of airtime to purchase
RecipientPhone
String
True
Phone No of recipient

Result Sample: 

TV Subscription

VerifySubscription

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?VerifySubscriptionTV     
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
serviceType
String
True
Either dstv, gotv or startime
smartCard
Double
True
Unique customer Identifier

Result Sample: 

Process TV Subscription

http Request: https://valueswitch.com.ng/api/WebPayments.asmx?ProcessTVSubscription      
Method: POST
Query Parameters
Parameters
Type
Required
Description
accesstoken
String
True
Token generated during authentication
MemberID
String
True
Your platform unique Identifier
ServiceType
String
True
Either dstv, gotv or startime
SmartCard
Double
True
Unique customer Identifier                 
Description
String
True

            
TransValue
Double
True
Amount of the Bouquet
RecipientPhone
String
True
Beneficiary Phone No

Result Sample: 

Transaction Cost: 70

Resources

Get Bank List

When using the ValueSwitch API, you’ll be required to enter a 3 - character bank code used to identify a bank. You can get this list of banks by calling the /banks endpoint.

http Request: https://valueswitch.com.ng/api/Resources?BankCodes      
Method: POST

Sample Result:

[{"BankName":"Access Bank Nigeria","SortCode":"044"},{"BankName":"Citibank","SortCode":"023"},{"BankName":"Diamond Bank Plc","SortCode":"063"},{"BankName":"Ecobank Nigeria Plc","SortCode":"050"},{"BankName":"Enterprise Bank Limited","SortCode":"084"},{"BankName":"Fidelity Bank Nigeria","SortCode":"070"},{"BankName":"First Bank of Nigeria","SortCode":"011"},{"BankName":"First City Monument Bank","SortCode":"214"},{"BankName":"First Rand Limited","SortCode":"000"},{"BankName":"FSDH Merchant Bank","SortCode":"000"},{"BankName":"Guaranty Trust Bank","SortCode":"058"},{"BankName":"Heritage Bank","SortCode":"030"},{"BankName":"Jaiz Bank","SortCode":"301"},{"BankName":"keystone Bank Plc","SortCode":"082"},{"BankName":"Skye Bank Plc","SortCode":"076"},{"BankName":"Stanbic IBTC Bank Plc","SortCode":"221"},{"BankName":"Standard Chartered Bank Nigeria Ltd","SortCode":"068"},{"BankName":"Sterling Bank Plc","SortCode":"232"},{"BankName":"Union Bank Nigeria Plc","SortCode":"032"},{"BankName":"United Bank for Africa Plc","SortCode":"033"},{"BankName":"Unity Bank Plc","SortCode":"215"},{"BankName":"Wema Bank Plc","SortCode":"035"},{"BankName":"Zenith Bank Plc","SortCode":"057"}]

Network Data Pricings

Networks whose data are available includes MTN, Airtel and 9Mobile

http Request: https://valueswitch.com.ng/api/Resources?NetworkDataList      
Method: POST
Query Parameters
Parameters
Type
Required
Description
networkType
String
True
Either MTN, Airtel or 9Mobile

Sample Result:

[{"Provider":"MTN","Description":"10MB - 24 HRS","Value":"100.00","Code":"MTN1"},{"Provider":"MTN","Description":"25MB - 24 HRS","Value":"150.00","Code":"MTN2"},{"Provider":"MTN","Description":"50MB - 24 HRS","Value":"200.00","Code":"MTN3"},{"Provider":"MTN","Description":"UNLIMITED 2 HRS","Value":"250.00","Code":"MTN4"},{"Provider":"MTN","Description":"25MB - 7 DAYS","Value":"400.00","Code":"MTN5"},{"Provider":"MTN","Description":"750MB - 7 DAYS","Value":"500.00","Code":"MTN6"},{"Provider":"MTN","Description":"1.5GB - 30 DAYS","Value":"1000.00","Code":"MTN7"},{"Provider":"MTN","Description":"3.5GB - 30 DAYS","Value":"2000.00","Code":"MTN8"},{"Provider":"MTN","Description":"UNLIMITED 20 HRS","Value":"1500.00","Code":"MTN9"},{"Provider":"MTN","Description":"3GB WEEKEND - 30 DAYS","Value":"3000.00","Code":"MTN10"},{"Provider":"MTN","Description":"3GB UNLIMITED","Value":"6500.00","Code":"MTN11"},{"Provider":"MTN","Description":"5GB UNLIMITED","Value":"8000.00","Code":"MTN12"},{"Provider":"MTN","Description":"22GB - 30 DAYS","Value":"10000.00","Code":"MTN13"}]


 Services Bundles
Retrieves a list of available service bouquets.
http Request: https://valueswitch.com.ng/api/Resources?ServiceBundles      
Method: POST
Query Parameters
Parameters
Type
Required
Description
serviceType
String
True
Either dstv, gotv,startimes

Result Sample:

[{"Provider":"DSTV","Description":"DStv Access","Value":"1900.00","Code":"ACSSE36"},{"Provider":"DSTV","Description":"DStv Family","Value":"3800.00","Code":"COFAME36"},{"Provider":"DSTV","Description":"DStv Compact","Value":"6300.00","Code":"COMPE36"},{"Provider":"DSTV","Description":"DStv Compact Plus","Value":"9420.00","Code":"COMPLE36"},{"Provider":"DSTV","Description":"DStv Premium","Value":"13980.00","Code":"PRWE36"},{"Provider":"DSTV","Description":"DStv Premium Asia","Value":"15740.00","Code":"PRWASIE36"},{"Provider":"DSTV","Description":"Asian Bouqet","Value":"5050.00","Code":"ASIAW4"},{"Provider":"DSTV","Description":"DStv Mobile MAXI","Value":"830.00","Code":"MOMAXI"},{"Provider":"DSTV","Description":"DStv Mobile MAXI Plus","Value":"1050.00","Code":"MOMAXIP"}]

Our Partners & Clients

Our Partners & Clients