/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.

Endpoint Info

Base URLapi.bizkithub.com

AuthBearer Token

Methods1

Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

3 query parameters

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

idstringrequired

Payment gateway transaction ID.

orderIdstringrequired

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

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/shop/payment/process-notification?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&id=TXN-123456&orderId=a1b2c3d4e5f6", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);

get

Example Response

200Success

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

cURL

Command line example

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"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key

Back to API Documentation API Reference