BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/payment-methods
getDashboardAdmin BFF

/bff/dashboard/payment-methods

Shows which payment methods customers prefer. Helps optimize conversion and reduce gateway fees by focusing on efficient methods.

DashboardgetBffDashboardPayment-methods

Parameters

1 query

1 total
Query · 1
daysnumber

Number of days to analyze. Defaults to 30.

Default: 30

Request

GET /bff/dashboard/payment-methods

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/payment-methods?days=30" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Payment methods analysis.

{
  "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"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key