Docs API Reference Payment Gateway/bff/payment-gateway/delete

/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

JSON body

Request body

application/json

codestringRequired

Gateway code to delete.

Examplegopay-sandbox

Response schema

1 status code documented

200SuccessGateway deleted successfully.

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

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"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key