Parameters
1 query
Query parameters
· 1daysnumberOptionalNumber of days to analyze. Defaults to 30.
Default:
30Example
30/bff/dashboard/payment-methods
Shows which payment methods customers prefer. Helps optimize conversion and reduce gateway fees by focusing on efficient methods.
DashboardgetBffDashboardPayment-methods
Response schema
1 status code documented
200SuccessPayment methods analysis.
totalOrdersnumberRequiredTotal paid orders.
totalRevenuenumberRequiredTotal revenue.
methodsobject[]RequiredPayment methods breakdown.
Each array item:
methodIdnumberRequiredPayment method ID.
methodCodestringRequiredPayment method code.
methodNamestringRequiredPayment method name.
orderCountnumberRequiredOrders using this method.
revenuenumberRequiredRevenue from this method.
avgOrderValuenumberRequiredAverage order value.
orderPercentagenumberRequiredPercentage of orders (0-100).
revenuePercentagenumberRequiredPercentage of revenue (0-100).
gatewaysobject[]RequiredOnline gateway performance.
Each array item:
gatewayCodestringRequiredGateway code.
gatewayNamestringRequiredGateway name.
paymentCountnumberRequiredTotal payment attempts.
successCountnumberRequiredSuccessful payments.
successRatenumberRequiredSuccess rate (0-100%).
currencystringRequiredCurrency code.
Response example
application/json{
"totalOrders": 0,
"totalRevenue": 0,
"methods": [
{
"methodId": 0,
"methodCode": "example_methodCode",
"methodName": "example_methodName",
"orderCount": 0,
"revenue": 0,
"avgOrderValue": 0,
"orderPercentage": 0,
"revenuePercentage": 0
}
],
"gateways": [
{
"gatewayCode": "example_gatewayCode",
"gatewayName": "example_gatewayName",
"paymentCount": 0,
"successCount": 0,
"successRate": 0
}
],
"currency": "example_currency"
}Request example
GET /bff/dashboard/payment-methods
curl -X GET "https://api.bizkithub.com/bff/dashboard/payment-methods?days=30" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Need an API key?
All BizKitHub public API endpoints require authentication via API key.