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

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessPayment success rate analysis.
overallSuccessRatenumberRequired

Overall payment success rate (0-100%).

totalPaymentsnumberRequired

Total number of payment attempts.

successfulPaymentsnumberRequired

Number of successful (paid) payments.

failedPaymentsnumberRequired

Number of failed/cancelled payments.

pendingPaymentsnumberRequired

Number of pending/in-progress payments.

byGatewayobject[]Required

Success rate breakdown by payment gateway.

Each array item:

Payment gateway performance.

gatewayCodestringRequired

Payment gateway identifier code.

gatewayNamestringRequired

Payment gateway display name.

successRatenumberRequired

Success rate for this gateway (0-100%).

totalPaymentsnumberRequired

Total payments via this gateway.

successfulPaymentsnumberRequired

Successful payments via this gateway.

failedPaymentsnumberRequired

Failed payments via this gateway.

dailyTrendobject[]Required

Daily success rate trend for charting.

Each array item:

Daily success rate data point.

datestringRequired

Date (YYYY-MM-DD).

successRatenumberRequired

Success rate for this day (0-100%).

totalnumberRequired

Total payment attempts on this day.

Response example

application/json
{
  "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
    }
  ]
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key