Docs API Reference Payment Gateway/bff/payment-gateway/commission-update

postPayment GatewayAdmin BFF

/bff/payment-gateway/commission-update

Update a commission period

Payment GatewaypostBffPayment-gatewayCommission-update

Parameters

JSON body

Request body

application/json

idstringRequired

Commission period ID.

Example1

fromDatestringOptional

New start (YYYY-MM-DD).

toDatestring | nullOptional

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

One of 2:

Variant 1

string

Variant 2

null

percentagenumberOptional

New percentage. Must be >= 0.

monthlyFeenumber | nullOptional

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

One of 2:

Variant 1

number

Variant 2

null

monthlyFeeMinTurnovernumber | nullOptional

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

One of 2:

Variant 1

number

Variant 2

null

notestring | nullOptional

New note.

One of 2:

Variant 1

string

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key