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

postPayment GatewayAdmin BFF

/bff/payment-gateway/commission-add

Add a commission period

Payment GatewaypostBffPayment-gatewayCommission-add

Parameters

JSON body

Request body

application/json

codestringRequired

Gateway instance code the period belongs to.

Examplegopay-production

fromDatestringRequired

Start of the validity period (inclusive), YYYY-MM-DD.

Example2026-01-01

toDatestring | nullOptional

End of the validity period (inclusive). Omit or pass null for open-ended.

One of 2:

Variant 1

string

Variant 2

null

percentagenumberRequired

Commission rate in percent (e.g. 1.25 for 1.25 %). Must be >= 0.

Example1.25

monthlyFeenumber | nullOptional

Flat monthly fee charged in addition to the percentage. Null/0 = no flat fee.

One of 2:

Variant 1

number

Variant 2

null

monthlyFeeMinTurnovernumber | nullOptional

Charge the flat fee only when the month's gateway turnover reaches this value. Null = charge unconditionally. Ignored when monthlyFee is null/0.

One of 2:

Variant 1

number

Variant 2

null

notestring | nullOptional

Optional note (contract ref, reason).

One of 2:

Variant 1

string

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

idstringRequired

Response example

application/json

{
  "success": true,
  "id": "example_id"
}

Request example

POST /bff/payment-gateway/commission-add

post

curl -X POST "https://api.bizkithub.com/bff/payment-gateway/commission-add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "gopay-production",
  "fromDate": "2026-01-01",
  "toDate": "2026-12-31",
  "percentage": 1.25,
  "monthlyFee": 100,
  "monthlyFeeMinTurnover": 50000
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key