DocsAPI ReferencePayment Gateway/bff/payment-gateway/toggle-active
postPayment GatewayAdmin BFF

/bff/payment-gateway/toggle-active

Quickly enable or disable a payment gateway. Disabled gateways cannot process new payments but existing payments can still be checked/synced.

Payment GatewaypostBffPayment-gatewayToggle-active

Parameters

2 body

2 total
Body · 2
codestringRequired

Gateway code.

activebooleanRequired

New active status.

Request

POST /bff/payment-gateway/toggle-active

post
curl -X POST "https://api.bizkithub.com/bff/payment-gateway/toggle-active" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "gopay-production",
  "active": true
}'

Response

Status toggled successfully.

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key