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

/bff/payment-gateway/payment-list

Returns a paginated list of online payment transactions. Supports filtering by order, gateway, and status. Use query params page and limit for pagination.

Payment GatewaygetBffPayment-gatewayPayment-list

Parameters

3 query

Query parameters

· 3
orderHashstringOptional

Filter by order hash. Returns payments for specific order.

Exampleabc123def
gatewayCodestringOptional

Filter by gateway code. Returns payments for specific gateway.

Examplegopay-production
statusstringOptional

Filter by payment status (e.g., "PAID", "PENDING", "CANCELLED").

ExamplePAID

Response schema

1 status code documented

200SuccessPaginated list of payment transactions.
itemsobject[]Required

List of payment transactions.

Each array item:

Payment transaction record.

idstringRequired

Composite payment identifier.

internal_idnumberRequired

Internal database ID.

gateway_idstringRequired

Provider-specific transaction ID.

gateway_codestringOptional

Gateway instance code.

provider_idnumberRequired

Payment provider ID.

gateway_descriptionstring | nullRequired

Gateway description; null when the operator left it blank.

One of 2:
Variant 1
string
Variant 2
null
gateway_namestringRequired

Provider name.

pricenumberRequired

Payment amount.

currency_codestringRequired

Currency code (e.g., "CZK", "EUR").

statusstringRequired

Current payment status.

inserted_dateDate | string | string | numberRequired

Date when payment was created.

One of 4:
Variant 1
Date

Date when payment was created.

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

Date of last status check.

One of 4:
Variant 1
Date

Date of last status check.

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

Human-readable payment label with status.

order_numberstringOptional

Associated order number.

order_hashstringOptional

Associated order hash for linking.

itemCountnumberRequired

Total number of payments matching the filter (for pagination).

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "internal_id": 0,
      "gateway_id": "example_gateway_id",
      "gateway_code": "example_gateway_code",
      "provider_id": 0,
      "gateway_name": "example_gateway_name",
      "price": 0,
      "currency_code": "example_currency_code",
      "status": "example_status",
      "label": "example_label",
      "order_number": "example_order_number",
      "order_hash": "example_order_hash"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/payment-gateway/payment-list

get
curl -X GET "https://api.bizkithub.com/bff/payment-gateway/payment-list?orderHash=abc123def&gatewayCode=gopay-production&status=PAID" \
  -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