Understanding How VTpass Commission Works
VTPass offers commissions to API users in the form of discounts on transactions. These commissions allow API agents to earn a portion (percentage or flat amount) of each transaction while providing seamless bill payment services to their customers.
If you’re looking to track your earnings, it’s essential to know where to find your VTPass commissions. In this guide, we’ll walk you through the steps to locate commission details, understand your earnings, and ensure you’re maximizing your profits on the platform. Below, you’ll find a step-by-step guide on how to retrieve and review your commission, helping you maximize your profits.
How API Commissions Work
Commissions are applied as discounts on transactions, reducing the final amount API customers pay instead of charging them the full transaction price.. The commission structure is categorized into three types:
1. Percentage-Based Discount
-
The commission is applied as a percentage of the transaction amount.
-
This means that the discount is dynamically calculated based on the total value of the transaction.
-
Example: If a 2% commission is applied to a ₦1,000 transaction, the discount will be ₦20, making the effective charge ₦980.
2. Flat Rate-Based Discount
-
The commission is applied as a fixed amount per transaction, regardless of the transaction value.
-
The discount is predetermined for each product.
-
Example: If a flat discount of ₦50 is set for a service, every transaction will receive a ₦50 reduction, irrespective of the transaction amount.
Where to Find VTPass Commissions
1. General Commission Information
You can view the general commission for each product directly on the website HERE
2. API-Based Commission Retrieval
You can access product-specific commission details through the verification, purchase, or requery endpoints in the API. These endpoints return a response that includes the commission_details
field. Additionally, if a product has a special commission, you can also retrieve its details in the commission_details
field.
Special commissions are predefined rules based on the product category or variation. For example, a product with a computation_type
of “nmd” may have a unique discount calculation method compared to standard flat-rate or percentage-based discounts.
"commission_details": { "amount": 50, "rate": "50", "rate_type": "flat", "computation_type": "nmd", "capped_at": "20" }
Explanation of Commission Fields
Field | Description |
---|---|
commission_details |
Contains commission details for the product. |
amount |
The actual discount applied to the transaction. For verification, this will return null; considering the amount for the purchase has not been set yet. Example: "amount": 50 means ₦50 is the discount for this transaction. |
rate |
The commission rate, used alongside rate_type to calculate the discount. Example: "rate": "2" with "rate_type": "percentage" means 2% of the transaction amount is deducted. |
rate_type |
Defines the type of discount: "percentage" (a percentage of the transaction amount) or "flat" (a fixed amount). Example: "rate": "50" with "rate_type": "flat" means ₦50 is deducted per transaction. |
computation_type |
Specifies if a special commission rule applies to the product. Default is "default" . Example: "nmd" may indicate a Net Merchant Discount model. |
capped_at |
Defines the maximum limit for the discount. If null , no cap is applied. Example: "capped_at": 20 means the commission cannot exceed ₦20, even if the calculated discount is higher. |