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

/bff/payment-gateway/connection-status

Checks if the gateway credentials are configured and tests the actual connection to the payment provider. Returns masked credentials for display in UI.

Payment GatewaygetBffPayment-gatewayConnection-status

Parameters

1 query

1 total
Query · 1
codestringRequired

Gateway instance code.

Request

GET /bff/payment-gateway/connection-status

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

Response

Gateway connection status and masked credentials.

{
  "configured": false,
  "connectionWorks": false,
  "credentials": {
    "merchantId": "example_merchantId",
    "publicKey": "example_publicKey",
    "secretKey": "example_secretKey",
    "secureKey": "example_secureKey"
  }
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key