Docs API Reference Payment Gateway/bff/payment-gateway/stats

/bff/payment-gateway/stats

Returns aggregated payment statistics grouped by gateway. Includes success rates, payment counts by status, and total amounts processed. Useful for analytics dashboards.

Payment GatewaygetBffPayment-gatewayStats

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200SuccessAggregated payment statistics.

itemsobject[]Required

Statistics grouped by gateway.

Each array item:

Statistics for a single gateway.

gatewayCodestringRequired

Gateway instance code.

gatewayNamestringRequired

Provider name.

totalPaymentsnumberRequired

Total number of payment attempts.

paidPaymentsnumberRequired

Number of successful payments.

failedPaymentsnumberRequired

Number of failed/cancelled payments.

pendingPaymentsnumberRequired

Number of pending payments.

totalAmountnumberRequired

Total amount from successful payments.

successRatenumberRequired

Success rate as percentage (0-100).

itemCountnumberRequired

Number of gateways with statistics.

Response example

application/json

{
  "items": [
    {
      "gatewayCode": "example_gatewayCode",
      "gatewayName": "example_gatewayName",
      "totalPayments": 0,
      "paidPayments": 0,
      "failedPayments": 0,
      "pendingPayments": 0,
      "totalAmount": 0,
      "successRate": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/payment-gateway/stats

get

curl -X GET "https://api.bizkithub.com/bff/payment-gateway/stats" \
  -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