BizKitHub
DocsAPI ReferencePayment Gateway/bff/payment-gateway/diagnose
getPayment GatewayAdmin BFF

/bff/payment-gateway/diagnose

Runs a full health check of the gateway: stored credentials, live connection to the provider (incl. IP-whitelist detection), production mode, order-group routing, invoice issuer and recent payment traffic. Each check carries a stable code the admin maps to an explanation and fix steps.

Payment GatewaygetBffPayment-gatewayDiagnose

Parameters

1 query

Query parameters

· 1
codestringRequired

Gateway instance code.

Examplecomgate

Response schema

1 status code documented

200Success
status"ok" | "info" | "warning" | "error"Required

Worst status across all checks (info never degrades it).

checksobject[]Required
Each array item:
codestringRequired

Stable check identifier.

Exampleconnection-ip-blocked
status"ok" | "info" | "warning" | "error"Required
paramsobjectRequired

Values for the explanation template.

detailstringOptional

Raw provider or log message.

provider"gopay" | "comgate" | "stripe"Required
environment"p" | "s" | "t"Required
merchantIdstringOptional
serverobjectRequired
outboundIpstringRequired

IPv4 the provider sees BizKitHub calls coming from.

comgatePushUrlstringRequired

URL to set as Comgate "Url pro předání výsledku platby".

checkedAtstringRequired

ISO timestamp of the check.

Response example

application/json
{
  "checks": [
    {
      "code": "connection-ip-blocked",
      "params": {},
      "detail": "example_detail"
    }
  ],
  "merchantId": "example_merchantId",
  "server": {
    "outboundIp": "example_outboundIp",
    "comgatePushUrl": "example_comgatePushUrl"
  },
  "checkedAt": "example_checkedAt"
}

Request example

GET /bff/payment-gateway/diagnose

get
curl -X GET "https://api.bizkithub.com/bff/payment-gateway/diagnose?code=comgate" \
  -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