BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/payment-success-rate
getDashboardAdmin BFF

/bff/dashboard/payment-success-rate

Returns payment success/failure statistics by gateway. Helps detect payment gateway issues before they impact revenue significantly.

DashboardgetBffDashboardPayment-success-rate

Parameters

1 query

1 total
Query · 1
daysnumber

Number of days to analyze. Defaults to 30.

Default: 30

Request

GET /bff/dashboard/payment-success-rate

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

Response

Payment success rate analysis.

{
  "overallSuccessRate": 0,
  "totalPayments": 0,
  "successfulPayments": 0,
  "failedPayments": 0,
  "pendingPayments": 0,
  "byGateway": [
    {
      "gatewayCode": "example_gatewayCode",
      "gatewayName": "example_gatewayName",
      "successRate": 0,
      "totalPayments": 0,
      "successfulPayments": 0,
      "failedPayments": 0
    }
  ],
  "dailyTrend": [
    {
      "date": "example_date",
      "successRate": 0,
      "total": 0
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key