Docs API Reference Payment Gateway/bff/payment-gateway/list-for-order-group

/bff/payment-gateway/list-for-order-group

Returns the union of (a) all payment gateway instances owned by the organisation and (b) gateway instances owned by other organisations that are already referenced by at least one of this organisation's order groups via shop__order_payment_gateway_preference (legacy cross-organisation bindings). Used by the workflow "Payment gateway for group" modal so the operator can keep historical bindings consistent across groups.

Payment GatewaygetBffPayment-gatewayList-for-order-group

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200SuccessMerged list of selectable gateway instances.

itemsobject[]Required

Each array item:

Gateway instance eligible for selection as an order-group preference.

codestringRequired

Unique identifier/slug for this gateway instance.

descriptionstringRequired

Human-readable description of the gateway configuration.

environment"p" | "s" | "t"Required

Environment: "p" = Production, "s" = Sandbox, "t" = Test.

activebooleanRequired

Whether the gateway is currently active.

gatewayCodestringRequired

Provider code (e.g., "gopay", "comgate", "stripe").

gatewayNamestringRequired

Human-readable provider name.

foreignbooleanRequired

True when the gateway instance is owned by a different organisation but already referenced by one of this organisation's order groups (legacy binding).

itemCountnumberRequired

Total number of items.

Response example

application/json

{
  "items": [
    {
      "code": "example_code",
      "description": "example_description",
      "active": false,
      "gatewayCode": "example_gatewayCode",
      "gatewayName": "example_gatewayName",
      "foreign": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/payment-gateway/list-for-order-group

get

curl -X GET "https://api.bizkithub.com/bff/payment-gateway/list-for-order-group" \
  -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