/api/v1/shop/payment/create

Initializes a payment gateway session for the given order and returns a redirect URL where the customer completes the payment.

paymentgetApiV1ShopPaymentCreate

Parameters

2 query

Query parameters

· 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

hashstringRequired

Unique order hash identifier.

Examplea1b2c3d4e5f6

Response schema

1 status code documented

200SuccessPayment gateway redirect URL.

gatewayUrlstringOptional

URL to redirect the customer to the payment gateway. Undefined if payment could not be created.

Examplehttps://payments.comgate.cz/client/instructions/index?id=ABC123

Response example

application/json

{
  "gatewayUrl": "https://payments.comgate.cz/client/instructions/index?id=ABC123"
}

Request example

GET /api/v1/shop/payment/create

get

curl -X GET "https://api.bizkithub.com/api/v1/shop/payment/create?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&hash=a1b2c3d4e5f6" \
  -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