BizKitHub
DocsAPI ReferenceIssue/bff/issue/payment-request-options
getIssueAdmin BFF

/bff/issue/payment-request-options

Everything the issue composer needs to attach a payment request: enabled currencies (org default + active bank-account currencies + currencies of recent orders) with QR availability, ACTIVE order groups with online-card availability, the pre-filled first item label in the issue language, and the customer (= reporter). Bootstraps the default order group when the organisation has none. Requires module-order.

IssuegetBffIssuePayment-request-options

Parameters

1 query

Query parameters

· 1
issueKeystringRequired

Issue key the payment request will be attached to.

ExamplePROJ-123

Response schema

1 status code documented

200Success
currenciesobject[]Required
Each array item:
codestringRequired
ExampleCZK
symbolstringRequired
ExampleKč
decimalsnumberRequired
Example2
isDefaultbooleanRequired

Organisation default currency.

qrAvailablebooleanRequired

A bank-transfer QR code can be rendered (CZK/EUR + active bank account in this currency).

groupsobject[]Required
Each array item:
codestringRequired
Exampledefault
namestringRequired
ExampleDefault
isDefaultbooleanRequired
cardAvailablebooleanRequired

An active online payment gateway serves this group, so the e-mail gets a "Pay by card" button.

defaultCurrencyCodestringRequired
ExampleCZK
defaultGroupCodestringRequired
Exampledefault
defaultItemLabelstringRequired
ExamplePlatba k požadavku PROJ-123
customerobjectRequired
namestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
phonestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
canCreatebooleanRequired

False when the reporter has neither e-mail nor phone, so no order customer can be resolved.

Response example

application/json
{
  "currencies": [
    {
      "code": "CZK",
      "symbol": "Kč",
      "decimals": 2,
      "isDefault": false,
      "qrAvailable": false
    }
  ],
  "groups": [
    {
      "code": "default",
      "name": "Default",
      "isDefault": false,
      "cardAvailable": false
    }
  ],
  "defaultCurrencyCode": "CZK",
  "defaultGroupCode": "default",
  "defaultItemLabel": "Platba k požadavku PROJ-123",
  "customer": {},
  "canCreate": false
}

Request example

GET /bff/issue/payment-request-options

get
curl -X GET "https://api.bizkithub.com/bff/issue/payment-request-options?issueKey=PROJ-123" \
  -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