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

/bff/payment-gateway/commission-list

Returns the chronological list of commission-rate validity periods configured for the given gateway instance. Each row defines a percentage that applies between fromDate (inclusive) and toDate (inclusive, NULL = open-ended). The Branch Finance roll-up uses the period matching each payment date to compute the "Poplatek bráně" column.

Payment GatewaygetBffPayment-gatewayCommission-list

Parameters

1 query

Query parameters

· 1

codestringRequired

Gateway instance code.

Examplegopay-production

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idstringRequired

Internal database ID of the commission period.

fromDatestringRequired

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

toDatestring | nullRequired

End of the period (inclusive). NULL = open-ended (still in force).

One of 2:

Variant 1

string

Variant 2

null

percentagenumberRequired

Commission rate in percent (e.g. 1.25 = 1.25 %).

monthlyFeenumber | nullRequired

Flat monthly fee in the gateway currency. NULL = no flat fee charged.

One of 2:

Variant 1

number

Variant 2

null

monthlyFeeMinTurnovernumber | nullRequired

Minimum gateway turnover the month must reach before the flat fee is charged. NULL = charge unconditionally. Ignored when monthlyFee is NULL.

One of 2:

Variant 1

number

Variant 2

null

notestring | nullRequired

Optional human note (contract ref, reason for change, …).

One of 2:

Variant 1

string

Variant 2

null

insertedDateDate | string | string | numberRequired

When the row was created.

One of 4:

Variant 1

Date

When the row was created.

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "id": "example_id",
      "fromDate": "example_fromDate",
      "percentage": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/payment-gateway/commission-list

get

curl -X GET "https://api.bizkithub.com/bff/payment-gateway/commission-list?code=gopay-production" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key