BizKitHub
DocsAPI ReferenceWorkflow/bff/workflow/group-set-payment-gateway
postWorkflowAdmin BFF

/bff/workflow/group-set-payment-gateway

Configures how online payments resolve for a given order group. "fallback" deletes any explicit preference (resolver picks the org-wide active gateway). "specific" binds the group to one gateway instance. "none" disables online payments for the group entirely — createPayment() will skip without redirect or fallback.

WorkflowpostBffWorkflowGroup-set-payment-gateway

Parameters

JSON body

Request body

application/json
groupCodestringRequired

Order group code to configure.

Examplerezervace-smichov
mode"fallback" | "specific" | "none"Required

"fallback" — clears any preference; resolver will use the org-wide active gateway. "specific" — bind the group to a single gateway instance (gatewayCode required). "none" — explicitly disable online payments for this group; resolver returns null, no fallback.

gatewayCodestring | nullOptional
One of 2:
Variant 1
string

Gateway instance code. Required when mode is "specific", ignored otherwise.

Examplegopay-production
Variant 2
null

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true

Response example

application/json
{
  "success": true
}

Request example

POST /bff/workflow/group-set-payment-gateway

post
curl -X POST "https://api.bizkithub.com/bff/workflow/group-set-payment-gateway" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "groupCode": "rezervace-smichov"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key