Docs API Reference Payment Gateway/bff/payment-gateway/payment-list

/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

3 total

Query · 3

orderHashstring

Filter by order hash. Returns payments for specific order.

gatewayCodestring

Filter by gateway code. Returns payments for specific gateway.

statusstring

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

Request

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"

Response

Paginated list of payment transactions.

{
  "items": [
    {
      "id": "example_id",
      "internal_id": 0,
      "gateway_id": "example_gateway_id",
      "gateway_code": "example_gateway_code",
      "provider_id": 0,
      "gateway_description": "example_gateway_description",
      "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
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key