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

No parameters

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

Request

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"

Response

Aggregated payment statistics.

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key