BizKitHub
DocsAPI ReferencePayment Gateway/bff/payment-gateway/list
getPayment GatewayAdmin BFF

/bff/payment-gateway/list

Returns a list of all configured payment gateway instances for the organisation. Each gateway includes basic configuration, usage statistics, and last activity date. Sensitive credentials (API keys, secrets) are NOT included - use the /keys endpoint for those.

Payment GatewaygetBffPayment-gatewayList

Parameters

No parameters required

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

Response schema

1 status code documented

200SuccessList of payment gateway instances with usage statistics.
itemsobject[]Required

List of configured payment gateways.

Each array item:

Payment gateway instance configuration and statistics.

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 and can process payments.

insertedDateDate | string | string | numberRequired

Date when the gateway was configured.

One of 4:
Variant 1
Date

Date when the gateway was configured.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
gatewayCodestringRequired

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

gatewayNamestringRequired

Human-readable provider name.

paymentCountnumberRequired

Total number of payments processed through this gateway.

lastUsedDateDate | string | string | numberOptional

Date of the most recent payment attempt.

One of 4:
Variant 1
Date

Date of the most recent payment attempt.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
issuerExternalIdstringRequired

External id (shop__contact.external_id) of the invoice issuer bound to this gateway.

issuerNamestringRequired

Display name of the invoice issuer — first + last name, falls back to company_name, falls back to the external id.

itemCountnumberRequired

Total number of gateway instances.

Response example

application/json
{
  "items": [
    {
      "code": "example_code",
      "description": "example_description",
      "active": false,
      "gatewayCode": "example_gatewayCode",
      "gatewayName": "example_gatewayName",
      "paymentCount": 0,
      "issuerExternalId": "example_issuerExternalId",
      "issuerName": "example_issuerName"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/payment-gateway/list

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