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

/bff/payment-gateway/detail

Returns detailed information about a specific payment gateway instance, including configuration, extended statistics (success rate, total amount processed), and metadata. Sensitive credentials are NOT included - use the /keys endpoint for those.

Payment GatewaygetBffPayment-gatewayDetail

Parameters

1 query

Query parameters

· 1
codestringRequired

Unique code/slug of the gateway instance.

Examplegopay-production

Response schema

1 status code documented

200SuccessDetailed gateway information with statistics.
idstringRequired

Internal database ID.

codestringRequired

Unique identifier/slug for this gateway instance.

descriptionstringRequired

Human-readable description.

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

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

environmentLabelstringRequired

Human-readable environment label.

activebooleanRequired

Whether the gateway is active.

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
merchantIdstringOptional

Merchant ID (if applicable for the provider).

extraobjectRequired

Additional provider-specific configuration.

providerIdnumberRequired

Internal provider ID.

gatewayCodestringRequired

Provider code.

gatewayNamestringRequired

Provider name.

paymentCountnumberRequired

Total number of payments.

paidPaymentCountnumberRequired

Number of successful payments.

totalAmountnumberRequired

Total amount processed (successful payments only).

lastUsedDateDate | string | string | numberOptional

Date of most recent payment.

One of 4:
Variant 1
Date

Date of most recent payment.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
firstUsedDateDate | string | string | numberOptional

Date of first payment.

One of 4:
Variant 1
Date

Date of first payment.

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

Invoice issuer bound to this gateway. Always present — the FK on the instance table is NOT NULL.

externalIdstringRequired

Issuer contact external id.

displayNamestringRequired

Issuer display name (first + last name; falls back to company name; falls back to id).

companyNamestringOptional

Company name if set.

companyRegistrationNumberstringOptional

Company registration number (IČO).

taxIdentificationNumberstringOptional

Tax identification number (DIČ / VAT id).

primaryAddressobjectOptional

Primary billing address of the issuer. Absent when the contact has none configured.

streetAddressstringOptional
citystringOptional
postalCodestringOptional
countrystringOptional
boundOrderGroupCountnumberRequired

How many shop__order_group rows in this org already use this contact as their invoice issuer. Non-zero means the admin can verify the same contact is really used as an invoice issuer elsewhere.

Response example

application/json
{
  "id": "example_id",
  "code": "example_code",
  "description": "example_description",
  "environmentLabel": "example_environmentLabel",
  "active": false,
  "merchantId": "example_merchantId",
  "extra": {},
  "providerId": 0,
  "gatewayCode": "example_gatewayCode",
  "gatewayName": "example_gatewayName",
  "paymentCount": 0,
  "paidPaymentCount": 0,
  "totalAmount": 0,
  "issuer": {
    "externalId": "example_externalId",
    "displayName": "example_displayName",
    "companyName": "example_companyName",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber",
    "primaryAddress": {
      "streetAddress": "example_streetAddress",
      "city": "example_city",
      "postalCode": "example_postalCode",
      "country": "example_country"
    },
    "boundOrderGroupCount": 0
  }
}

Request example

GET /bff/payment-gateway/detail

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