Docs API Reference Payment Gateway/bff/payment-gateway/connection-status

/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

Query parameters

· 1

codestringRequired

Gateway instance code.

Examplegopay-production

Response schema

1 status code documented

200SuccessGateway connection status and masked credentials.

configuredbooleanRequired

Whether credentials are fully configured.

connectionWorksbooleanRequired

Whether the connection test succeeded.

provider"gopay" | "comgate" | "stripe"Required

Payment provider type.

environment"p" | "s" | "t"Required

Environment: "p" = Production, "s" = Sandbox, "t" = Test.

credentialsobjectRequired

Masked credentials for UI display.

merchantIdstringOptional

Merchant ID (if applicable).

publicKeystringOptional

Public API key (if applicable).

secretKeystringOptional

Masked secret API key.

secureKeystringOptional

Masked secure key.

Response example

application/json

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

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key