DocsAPI ReferencePayment Gateway/bff/payment-gateway/delete
postPayment GatewayAdmin BFF

/bff/payment-gateway/delete

Permanently deletes a payment gateway instance. This operation is only allowed if the gateway has no associated payments. If payments exist, deactivate the gateway instead.

Payment GatewaypostBffPayment-gatewayDelete

Parameters

1 body

1 total
Body · 1
codestringRequired

Gateway code to delete.

Request

POST /bff/payment-gateway/delete

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

Response

Gateway deleted 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