Comment on page

Know the Parameters

First, take a few minutes to familiarize yourself with the supported parameters required to complete your integration through our API.
Parameters
Expected Value
Explanation
v_merchant_id
Merchant ID. Can be found on the Merchant VoguePay dashboard
Your merchant ID is your unique account identifier.

Your merchant ID can be found in Account Settings on your dashboard. Your merchant ID is a set of numbers separated with a hyphen (-) e.g. 1234-0000, 2817-0154360
cur
3 letters Currency code.
Supported currency codes
NGN - Nigerian Naira
USD - US Dollar
EUR - Euro
GBP - British Pound
ZAR - South African Rand
JPY - Japanese yen
INR - India Rupiee
AUD - Australia Dollar

This field is optional. If not provided, the transaction will be initiated and processed in the default currency of your VoguePay account.
In situations when a currency code is provided, and the provided country code differs from the VoguePay account currency. VoguePay conversion rates will be used for settlements.
merchant_ref
Can be any value provided by the merchant.
This identifier is recommended but yet remains optional.
Any value provided here, will be returned with the confirmation results. VoguePay does not use this value, it is used by the merchant to store any data to be retrieved later with the transaction details.
memo
Transaction Description - Can be any value provided by the merchant.
This is the transaction summary or description
developer_code
A unique code generated by VoguePay for Developers
A code is unique to every developer. Using this code earns the developer a commission on every successful transaction made through any selected integration methods. To get a developer code, Login to your VoguePay account and select 'Developer Codes' on your dashboard
total
Total Amount to charge the customer.
Total Amount to be charged.
notify_url
A URL provided by the merchant.
If provided, a notification is sent automatically to this notification URL immediately after the status of a transaction is confirmed.
success_url
A URL provided by the merchant.
If provided, buyers are automatically redirected to the success URL on completion of a successful transaction.
​
When no success URL is provided, buyers are automatically redirected to the URL from which the transaction originated.
NB: This requires redirection to be triggered.
fail_url
A URL provided by the merchant
If provided, buyers are automatically redirected to the fail URL when a transaction is declined or not successful.
​
When no fail URL is provided and no fail URL is set in the account settings, buyers are automatically redirected to the URL from which the transaction originated.
NB: This requires redirection to be triggered.

Integration Options

Simple HTML Form

Last modified 2yr ago

Parameters	Expected Value	Explanation
v_merchant_id	Merchant ID. Can be found on the Merchant VoguePay dashboard	Your merchant ID is your unique account identifier. Your merchant ID can be found in Account Settings on your dashboard. Your merchant ID is a set of numbers separated with a hyphen (-) e.g. 1234-0000, 2817-0154360
cur	3 letters Currency code.	Supported currency codes NGN - Nigerian Naira USD - US Dollar EUR - Euro GBP - British Pound ZAR - South African Rand JPY - Japanese yen INR - India Rupiee AUD - Australia Dollar This field is optional. If not provided, the transaction will be initiated and processed in the default currency of your VoguePay account. In situations when a currency code is provided, and the provided country code differs from the VoguePay account currency. VoguePay conversion rates will be used for settlements.
merchant_ref	Can be any value provided by the merchant.	This identifier is recommended but yet remains optional. Any value provided here, will be returned with the confirmation results. VoguePay does not use this value, it is used by the merchant to store any data to be retrieved later with the transaction details.
memo	Transaction Description - Can be any value provided by the merchant.	This is the transaction summary or description
developer_code	A unique code generated by VoguePay for Developers	A code is unique to every developer. Using this code earns the developer a commission on every successful transaction made through any selected integration methods. To get a developer code, Login to your VoguePay account and select 'Developer Codes' on your dashboard
total	Total Amount to charge the customer.	Total Amount to be charged.
notify_url	A URL provided by the merchant.	If provided, a notification is sent automatically to this notification URL immediately after the status of a transaction is confirmed.
success_url	A URL provided by the merchant.	If provided, buyers are automatically redirected to the success URL on completion of a successful transaction. When no success URL is provided, buyers are automatically redirected to the URL from which the transaction originated. NB: This requires redirection to be triggered.
fail_url	A URL provided by the merchant	If provided, buyers are automatically redirected to the fail URL when a transaction is declined or not successful. When no fail URL is provided and no fail URL is set in the account settings, buyers are automatically redirected to the URL from which the transaction originated. NB: This requires redirection to be triggered.