BizKitHub
DocsAPI ReferencePayment Gateway/bff/payment-gateway/test-connection
postPayment GatewayAdmin BFF

/bff/payment-gateway/test-connection

Tests the connection to a payment gateway with provided credentials. If a gateway code is provided, missing credentials will be loaded from the database, allowing you to test new credentials alongside existing ones.

Payment GatewaypostBffPayment-gatewayTest-connection

Parameters

7 body

7 total
Body · 7
codestring

Gateway code - if provided, missing credentials are loaded from DB.

providerstring | string | stringRequired

Payment provider type.

environmentstring | string | string

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

publicKeystring

Public API key.

secretKeystring

Secret API key.

merchantIdstring

Merchant ID.

secureKeystring

Secure key.

Request

POST /bff/payment-gateway/test-connection

post
curl -X POST "https://api.bizkithub.com/bff/payment-gateway/test-connection" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "gopay-production",
  "publicKey": "example_publicKey",
  "secretKey": "example_secretKey",
  "merchantId": "example_merchantId",
  "secureKey": "example_secureKey"
}'

Response

Connection test result.

{
  "success": false,
  "errorMessage": "example_errorMessage"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key