/api/v1/shop/payment/process-notification

Processes a payment gateway callback/notification. Checks the current payment status with the gateway and returns the result with an optional redirect URL.

paymentgetApiV1ShopPaymentProcess-notification

Parameters

3 query

Query parameters

· 3

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

idstringRequired

Payment gateway transaction ID.

ExampleTXN-123456

orderIdstringRequired

Order hash identifier (same as used in /create).

Examplea1b2c3d4e5f6

Response schema

1 status code documented

200SuccessPayment status check result.

statusstringRequired

Payment status from the gateway.

ExamplesPAIDPENDINGCANCELLED

redirectUrlstringOptional

URL to redirect the customer after payment processing.

Response example

application/json

{
  "status": "PAID",
  "redirectUrl": "example_redirectUrl"
}

Request example

GET /api/v1/shop/payment/process-notification

get

curl -X GET "https://api.bizkithub.com/api/v1/shop/payment/process-notification?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&id=TXN-123456&orderId=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