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

/bff/payment-gateway/detail

Returns detailed information about a specific payment gateway instance, including configuration, extended statistics (success rate, total amount processed), and metadata. Sensitive credentials are NOT included - use the /keys endpoint for those.

Payment GatewaygetBffPayment-gatewayDetail

Parameters

1 query

1 total

Query · 1

codestringRequired

Unique code/slug of the gateway instance.

Request

GET /bff/payment-gateway/detail

get

curl -X GET "https://api.bizkithub.com/bff/payment-gateway/detail?code=gopay-production" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Detailed gateway information with statistics.

{
  "id": "example_id",
  "code": "example_code",
  "description": "example_description",
  "environmentLabel": "example_environmentLabel",
  "active": false,
  "merchantId": "example_merchantId",
  "extra": {},
  "providerId": 0,
  "gatewayCode": "example_gatewayCode",
  "gatewayName": "example_gatewayName",
  "paymentCount": 0,
  "paidPaymentCount": 0,
  "totalAmount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key