/bff/payment-gateway/commission-update

Update a commission period

Payment GatewaypostBffPayment-gatewayCommission-update

Parameters

7 body

7 total

Body · 7

idstringRequired

Commission period ID.

fromDatestring

New start (YYYY-MM-DD).

toDatestring | null

New end (YYYY-MM-DD) or null for open-ended.

percentagenumber

New percentage. Must be >= 0.

monthlyFeenumber | null

New flat monthly fee. Null/0 clears the flat fee (and its turnover threshold).

monthlyFeeMinTurnovernumber | null

New turnover threshold gating the flat fee. Null = charge unconditionally. Forced to null when monthlyFee is cleared.

notestring | null

New note.

Request

POST /bff/payment-gateway/commission-update

post

curl -X POST "https://api.bizkithub.com/bff/payment-gateway/commission-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "1",
  "fromDate": "example_fromDate",
  "percentage": 0
}'

Response

JSON payload

{
  "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