
Webhooks
The Payment Link Transaction Webhooks API allows you to receive real-time notifications for payment link transactions. This feature helps you monitor and manage payment link transactions efficiently, ensuring you can act promptly on any payment events.
| Method | Path | Format | Authentication |
|---|---|---|---|
| POST | https://your-webhook-url/callback | json | HMAC SHA512 Signature |
This webhook sends a POST request to your configured transaction_notif_url when a Payment Link transaction is successfully processed.

The transaction_notif_url configuration can be accessed from the settings page as shown in the screenshot above.
When a Payment Link transaction is completed, Singa Payment Gateway will send a webhook notification to your registered callback URL. The request includes security headers for verification.
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| Content-Type | application/json | Alphabetic | Mandatory | Specifies JSON format for the request body | application/json | |
| User-Agent | SingaPaymentGateway/1.0 | Alphabetic | Mandatory | Identifies the source of the webhook | SingaPaymentGateway/1.0 | |
| X-Signature | Alphanumeric | Optional* | 128 | HMAC SHA512 signature for request verification (included when signature security is enabled) | 5f4dcc3b5aa765d61d8327deb882cf99… | |
| X-Timestamp | Numeric | Optional* | 10 | Unix timestamp in seconds when the request was sent (included when signature security is enabled) | 1695711945 | |
| Authorization | Bearer <access_token> | Alphanumeric | Optional* | Bearer token for authentication (included when signature security is enabled) | Bearer a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 |
* Note: Headers marked as “Optional” are included when you enable signature-based security. See the Security Mechanisms section below to understand the different security options available.
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | 1 | Indicates if the transaction was successful | true |
| event | String | Mandatory | - | Event type identifier | payment-link-transaction |
| timestamp | String | Mandatory | - | Event timestamp in format “d M Y H:i:s” | 26 Dec 2025 14:30:45 |
| data | Object | Mandatory | - | Container for transaction, customer, and payment details | - |
| > transaction | Object | Mandatory | - | Transaction details | - |
| >> reff_no | Alphanumeric | Mandatory | 26 | Unique transaction reference number | 3211120250926133543246 |
| >> type | String | Mandatory | - | Transaction type (always “pl” for Payment Link) | pl |
| >> status | String | Mandatory | - | Transaction status (always “paid” for this webhook) | paid |
| >> amount | Object | Mandatory | - | Transaction amount details | - |
| >>> value | Numeric | Mandatory | - | Transaction amount value | 100000 |
| >>> currency | String | Mandatory | 3 | Currency code | IDR |
| >> tip | Null | Mandatory | - | Tip amount (always null for Payment Link) | null |
| >> post_timestamp | String | Mandatory | - | Transaction post time | 26 Dec 2025 14:30:43 |
| >> processed_timestamp | String | Mandatory | - | Transaction processed time | 26 Dec 2025 14:30:45 |
| > customer | Object | Mandatory | - | Customer details (if provided during payment) | - |
| >> id | Null | Mandatory | - | Customer unique ID (always null for Payment Link) | null |
| >> name | String | Optional | - | Customer name (if provided) | John Doe |
| String | Optional | - | Customer email address (if provided) | john@example.com | |
| >> phone | String | Optional | - | Customer phone number (if provided) | 08123456789 |
| > payment | Object | Mandatory | - | Payment method details | - |
| >> method | String | Mandatory | - | Payment method (always “payment_link”) | payment_link |
| >> additional_info | Object | Mandatory | - | Payment method specific information | - |
| >>> payment_link | Object | Mandatory | - | Payment Link details | - |
| >>>> id | Numeric | Mandatory | - | Payment Link ID | 123 |
| >>>> reff_no | Alphanumeric | Mandatory | 26 | Payment Link reference number | PL3211120250926133543246 |
| >>>> title | String | Mandatory | - | Payment Link title | Invoice #INV-001 |
| >>>> payment_date | String | Optional | - | Actual payment date | 2025-12-26 14:30:45 |
| >>>> payment_url | String | Mandatory | - | Payment Link URL | https://pay.singapay.id/abc123 |
| >>>> status | String | Mandatory | - | Payment Link status | active |
| >>>> required_customer_detail | Boolean | Mandatory | - | Whether customer details are required | true |
| >>>> max_usage | Numeric | Optional | - | Maximum usage limit (null for unlimited) | 10 |
| >>>> current_usage | Numeric | Mandatory | - | Current usage count | 5 |
| >>>> expired_at | String | Optional | - | Expiration date (null if no expiration) | 2025-12-31 23:59:59 |
| >>>> total_amount | Numeric | Mandatory | - | Total amount for this Payment Link | 100000 |
| >>>> account_id | Numeric | Mandatory | - | Associated account ID | 456 |
| >>>> created_at | String | Mandatory | - | Payment Link creation date | 2025-12-20 10:00:00 |
| >>>> updated_at | String | Mandatory | - | Last update date | 2025-12-26 14:30:45 |
Success: Here’s an example of a successful webhook payload.
{
"status": 200,
"success": true,
"event": "payment-link-transaction",
"timestamp": "26 Dec 2025 14:30:45",
"data": {
"transaction": {
"reff_no": "3211120250926133543246",
"type": "pl",
"status": "paid",
"amount": {
"value": 100000,
"currency": "IDR"
},
"tip": null,
"post_timestamp": "26 Dec 2025 14:30:43",
"processed_timestamp": "26 Dec 2025 14:30:45"
},
"customer": {
"id": null,
"name": "John Doe",
"email": "john@example.com",
"phone": "08123456789"
},
"payment": {
"method": "payment_link",
"additional_info": {
"payment_link": {
"id": 123,
"reff_no": "PL3211120250926133543246",
"title": "Invoice #INV-001",
"payment_date": "2025-12-26 14:30:45",
"payment_url": "https://pay.singapay.id/abc123",
"status": "active",
"required_customer_detail": true,
"max_usage": 10,
"current_usage": 5,
"expired_at": "2025-12-31 23:59:59",
"total_amount": 100000,
"account_id": 456,
"created_at": "2025-12-20 10:00:00",
"updated_at": "2025-12-26 14:30:45"
}
}
}
}
}
To ensure the security and authenticity of webhook requests from Singa Payment Gateway, we provide two recommended security mechanisms. You can choose one or combine both for maximum protection.
Important Note: Signature validation is optional but highly recommended. You can secure your webhook endpoint using either IP whitelisting, signature validation, or both methods together.
This is the simplest security method where you restrict webhook access to only authorized IP addresses from Singa Payment Gateway.
How it works:
Pros:
Cons:
Implementation Example (Nginx):
location /webhook/payment-link {
# Only allow Singa Payment Gateway IPs
allow 103.xxx.xxx.xxx; # Replace with actual IPs from Singa
allow 103.xxx.xxx.xxx; # Replace with actual IPs from Singa
deny all;
proxy_pass http://your-backend;
}
Implementation Example (PHP):
<?php
// Define allowed IPs (get these from Singa Payment Gateway)
$allowedIPs = [
'103.xxx.xxx.xxx',
'103.xxx.xxx.xxx',
];
$requestIP = $_SERVER['REMOTE_ADDR'];
if (!in_array($requestIP, $allowedIPs)) {
http_response_code(403);
echo json_encode(['status' => 'error', 'message' => 'Access denied']);
exit;
}
// Process webhook...
?>
This method uses cryptographic signatures to verify that:
How it works:
Pros:
Cons:
When to use: Production environments, handling sensitive transactions, or when maximum security is required.
See the detailed implementation guide in the “How to Validate Signature” section below.
For production environments, we strongly recommend using both IP whitelisting and signature validation together.
Implementation order:
Benefits:
Example Implementation:
<?php
// Layer 1: IP Whitelist
$allowedIPs = ['103.xxx.xxx.xxx', '103.xxx.xxx.xxx'];
$requestIP = $_SERVER['REMOTE_ADDR'];
if (!in_array($requestIP, $allowedIPs)) {
http_response_code(403);
exit;
}
// Layer 2: Signature Validation
$requestBody = file_get_contents('php://input');
$headers = getallheaders();
$clientSecret = 'your-client-secret';
$endpoint = '/webhook/payment-link';
if (!validateWebhookSignature($requestBody, $headers, $clientSecret, $endpoint)) {
http_response_code(401);
exit;
}
// Both checks passed - process webhook
$payload = json_decode($requestBody, true);
// ... process transaction ...
?>
| Recommended Approach | Reason |
|---|---|
| IP Whitelist only | Simple to implement, easy to debug, suitable for testing environments |
| Signature validation only | Higher security, good for testing signature implementation |
| IP Whitelist + Signature ⭐ | Maximum security, industry best practice, recommended for production |
| IP Whitelist + Signature + Timestamp validation | Additional protection against replay attacks for high-security requirements |
To implement IP whitelisting, contact our support team or check your merchant dashboard for the official list of Singa Payment Gateway IP addresses.
Note: We will notify you in advance if our IP addresses change.
The X-Signature header is a security mechanism that ensures the webhook request is authentic and comes from Singa Payment Gateway. This signature is generated using HMAC SHA512 algorithm.
Note: While signature validation is optional, we strongly recommend implementing it, especially for production environments, to ensure maximum security and data integrity.
The signature is created using a multi-step process that combines the request method, endpoint, access token, hashed body, and timestamp.
Extract the following headers from the incoming webhook request:
Retrieve your Client Secret from the merchant dashboard. This is the same secret used for API authentication and is required as the HMAC key for signature verification.
Important: The Client Secret must be kept secure and never exposed in client-side code or logs.
Extract the endpoint path from your webhook URL. For example:
https://yourdomain.com/webhook/payment-link?param=value/webhook/payment-link?param=valueThe endpoint includes the path and any query parameters.
The request body must be normalized before hashing to ensure consistent results:
JSON_UNESCAPED_UNICODE - Don’t escape Unicode charactersJSON_UNESCAPED_SLASHES - Don’t escape forward slashesExample:
Original JSON: {"status":200,"success":true,"data":{"transaction":{"reff_no":"123"}}}
After sorting: {"data":{"transaction":{"reff_no":"123"}},"status":200,"success":true}
SHA-256 Hash: 5f4dcc3b5aa765d61d8327deb882cf99acd3d28e5cf0e661c02c8e8e6e8e6f9a
Concatenate the following values with colon (:) as separator:
StringToSign = METHOD + ":" + ENDPOINT + ":" + ACCESS_TOKEN + ":" + HASHED_BODY + ":" + TIMESTAMP
Example:
Method: POST
Endpoint: /webhook/payment-link
Access Token: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Hashed Body: 5f4dcc3b5aa765d61d8327deb882cf99acd3d28e5cf0e661c02c8e8e6e8e6f9a
Timestamp: 1695711945
StringToSign = POST:/webhook/payment-link:a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6:5f4dcc3b5aa765d61d8327deb882cf99acd3d28e5cf0e661c02c8e8e6e8e6f9a:1695711945
Use your Client Secret as the HMAC key and hash the string to sign:
Calculated Signature = HMAC-SHA512(StringToSign, Client Secret)
Compare the calculated signature with the signature from the X-Signature header using a constant-time comparison to prevent timing attacks.
Important: Use hash_equals() in PHP, crypto.timingSafeEqual() in Node.js, or hmac.compare_digest() in Python for secure comparison.
if (hash_equals($calculatedSignature, $receivedSignature)) {
// Signature is valid - process webhook
} else {
// Signature is invalid - reject request
}
<?php
/**
* Validate webhook signature from Singa Payment Gateway
*/
function validateWebhookSignature($requestBody, $headers, $clientSecret, $endpoint) {
// Step 1: Extract headers
$receivedSignature = $headers['X-Signature'] ?? '';
$timestamp = $headers['X-Timestamp'] ?? '';
$authorization = $headers['Authorization'] ?? '';
// Extract access token from "Bearer {token}"
$accessToken = str_replace('Bearer ', '', $authorization);
// Step 2: Normalize and hash the request body
$bodyArray = json_decode($requestBody, true);
if (json_last_error() !== JSON_ERROR_NONE) {
return false; // Invalid JSON
}
// Sort keys recursively
function sortRecursive(&$array) {
ksort($array, SORT_STRING);
foreach ($array as &$value) {
if (is_array($value)) {
sortRecursive($value);
}
}
}
sortRecursive($bodyArray);
// Re-encode with specific flags
$normalizedJson = json_encode($bodyArray, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
// Hash with SHA-256
$hashedBody = hash('sha256', $normalizedJson);
// Step 3: Build string to sign
$method = 'POST'; // Webhooks always use POST
$stringToSign = "{$method}:{$endpoint}:{$accessToken}:{$hashedBody}:{$timestamp}";
// Step 4: Generate HMAC SHA512 signature
$calculatedSignature = hash_hmac('sha512', $stringToSign, $clientSecret);
// Step 5: Compare signatures using constant-time comparison
return hash_equals($calculatedSignature, $receivedSignature);
}
// Usage example
$requestBody = file_get_contents('php://input');
$headers = getallheaders();
$clientSecret = 'your-client-secret-from-dashboard'; // Get from merchant dashboard
$endpoint = '/webhook/payment-link'; // Your webhook endpoint path
if (validateWebhookSignature($requestBody, $headers, $clientSecret, $endpoint)) {
// Signature is valid - process webhook
$payload = json_decode($requestBody, true);
// Process the transaction
$reffNo = $payload['data']['transaction']['reff_no'];
$amount = $payload['data']['transaction']['amount']['value'];
$paymentLinkId = $payload['data']['payment']['additional_info']['payment_link']['id'];
$customerName = $payload['data']['customer']['name'] ?? 'Guest';
// Update your database, send notifications, etc.
// Return success response
http_response_code(200);
echo json_encode(['status' => 'success']);
} else {
// Signature is invalid - reject request
http_response_code(401);
echo json_encode(['status' => 'error', 'message' => 'Invalid signature']);
}
?>
import hmac
import hashlib
import json
from flask import Flask, request, jsonify
app = Flask(__name__)
def sort_dict_recursive(data):
"""Recursively sort dictionary keys"""
if isinstance(data, dict):
return {k: sort_dict_recursive(v) for k, v in sorted(data.items())}
elif isinstance(data, list):
return [sort_dict_recursive(item) for item in data]
else:
return data
def validate_webhook_signature(request_body, headers, client_secret, endpoint):
"""Validate webhook signature from Singa Payment Gateway"""
# Step 1: Extract headers
received_signature = headers.get('X-Signature', '')
timestamp = headers.get('X-Timestamp', '')
authorization = headers.get('Authorization', '')
# Extract access token from "Bearer {token}"
access_token = authorization.replace('Bearer ', '')
# Step 2: Parse and normalize JSON
try:
body_dict = json.loads(request_body)
except json.JSONDecodeError:
return False
# Sort keys recursively
sorted_body = sort_dict_recursive(body_dict)
# Re-encode with specific settings
normalized_json = json.dumps(sorted_body, ensure_ascii=False, separators=(',', ':'))
# Hash with SHA-256
hashed_body = hashlib.sha256(normalized_json.encode('utf-8')).hexdigest()
# Step 3: Build string to sign
method = 'POST' # Webhooks always use POST
string_to_sign = f"{method}:{endpoint}:{access_token}:{hashed_body}:{timestamp}"
# Step 4: Generate HMAC SHA512 signature
calculated_signature = hmac.new(
client_secret.encode('utf-8'),
string_to_sign.encode('utf-8'),
hashlib.sha512
).hexdigest()
# Step 5: Compare signatures using constant-time comparison
return hmac.compare_digest(calculated_signature, received_signature)
@app.route('/webhook/payment-link', methods=['POST'])
def webhook_payment_link():
"""Handle Payment Link transaction webhook"""
request_body = request.get_data(as_text=True)
headers = dict(request.headers)
client_secret = 'your-client-secret-from-dashboard' # Get from merchant dashboard
endpoint = '/webhook/payment-link' # Your webhook endpoint path
if validate_webhook_signature(request_body, headers, client_secret, endpoint):
# Signature is valid - process webhook
payload = json.loads(request_body)
# Process the transaction
reff_no = payload['data']['transaction']['reff_no']
amount = payload['data']['transaction']['amount']['value']
payment_link_id = payload['data']['payment']['additional_info']['payment_link']['id']
customer_name = payload['data']['customer'].get('name', 'Guest')
# Update your database, send notifications, etc.
# Return success response
return jsonify({'status': 'success'}), 200
else:
# Signature is invalid - reject request
return jsonify({'status': 'error', 'message': 'Invalid signature'}), 401
if __name__ == '__main__':
app.run(port=3000)
const express = require('express');
const crypto = require('crypto');
const app = express();
// Middleware to capture raw body for signature validation
app.use(express.json({
verify: (req, res, buf) => {
req.rawBody = buf.toString('utf8');
}
}));
/**
* Recursively sort object keys
*/
function sortObjectRecursive(obj) {
if (typeof obj !== 'object' || obj === null) {
return obj;
}
if (Array.isArray(obj)) {
return obj.map(sortObjectRecursive);
}
const sorted = {};
Object.keys(obj).sort().forEach(key => {
sorted[key] = sortObjectRecursive(obj[key]);
});
return sorted;
}
/**
* Validate webhook signature from Singa Payment Gateway
*/
function validateWebhookSignature(requestBody, headers, clientSecret, endpoint) {
// Step 1: Extract headers
const receivedSignature = headers['x-signature'] || '';
const timestamp = headers['x-timestamp'] || '';
const authorization = headers['authorization'] || '';
// Extract access token from "Bearer {token}"
const accessToken = authorization.replace('Bearer ', '');
// Step 2: Parse and normalize JSON
let bodyObject;
try {
bodyObject = JSON.parse(requestBody);
} catch (e) {
return false; // Invalid JSON
}
// Sort keys recursively
const sortedBody = sortObjectRecursive(bodyObject);
// Re-encode JSON (no escaping for unicode and slashes)
const normalizedJson = JSON.stringify(sortedBody);
// Hash with SHA-256
const hashedBody = crypto
.createHash('sha256')
.update(normalizedJson)
.digest('hex');
// Step 3: Build string to sign
const method = 'POST'; // Webhooks always use POST
const stringToSign = `${method}:${endpoint}:${accessToken}:${hashedBody}:${timestamp}`;
// Step 4: Generate HMAC SHA512 signature
const calculatedSignature = crypto
.createHmac('sha512', clientSecret)
.update(stringToSign)
.digest('hex');
// Step 5: Compare signatures using constant-time comparison
return crypto.timingSafeEqual(
Buffer.from(calculatedSignature),
Buffer.from(receivedSignature)
);
}
// Webhook endpoint
app.post('/webhook/payment-link', (req, res) => {
const requestBody = req.rawBody;
const headers = req.headers;
const clientSecret = 'your-client-secret-from-dashboard'; // Get from merchant dashboard
const endpoint = '/webhook/payment-link'; // Your webhook endpoint path
if (validateWebhookSignature(requestBody, headers, clientSecret, endpoint)) {
// Signature is valid - process webhook
const payload = req.body;
// Process the transaction
const reffNo = payload.data.transaction.reff_no;
const amount = payload.data.transaction.amount.value;
const paymentLinkId = payload.data.payment.additional_info.payment_link.id;
const customerName = payload.data.customer.name || 'Guest';
// Update your database, send notifications, etc.
// Return success response
res.status(200).json({ status: 'success' });
} else {
// Signature is invalid - reject request
res.status(401).json({ status: 'error', message: 'Invalid signature' });
}
});
app.listen(3000, () => {
console.log('Webhook server running on port 3000');
});
Best Practices
hash_equals(), crypto.timingSafeEqual(), or hmac.compare_digest())client_secret as the HMAC keyCommon Mistakes to Avoid
:, not _ or -)If signature validation fails:
METHOD:ENDPOINT:ACCESS_TOKEN:HASHED_BODY:TIMESTAMPYour webhook endpoint must return an appropriate HTTP response:
When the webhook is processed successfully:
Status Code: 200 OK
{
"status": "success"
}
Invalid Signature (401 Unauthorized):
{
"status": "error",
"message": "Invalid signature"
}
Processing Error (500 Internal Server Error):
{
"status": "error",
"message": "Failed to process webhook"
}
Important: Singa Payment Gateway will retry failed webhooks (non-200 responses) up to 3 times with exponential backoff.
Customer information (name, email, phone) in the webhook payload depends on your Payment Link configuration:
required_customer_detail is true: Customer must provide their details before payment, and these will be included in the webhookrequired_customer_detail is false: Customer details may be null or omittedImportant: Always check if customer fields exist before using them in your code:
// PHP example
$customerName = $payload['data']['customer']['name'] ?? 'Guest';
$customerEmail = $payload['data']['customer']['email'] ?? null;
// JavaScript example
const customerName = payload.data.customer.name || 'Guest';
const customerEmail = payload.data.customer.email || null;
The payment_link object in additional_info contains the complete Payment Link details at the time of payment. You can use this to:
current_usage vs max_usage)payment_link.reff_no or payment_link.idAfter each successful payment:
current_usage is automatically incrementedcurrent_usage reaches max_usage, the payment link becomes inactivecurrent_usage valueExample - Check if payment link is at capacity:
$paymentLink = $payload['data']['payment']['additional_info']['payment_link'];
if ($paymentLink['max_usage'] !== null &&
$paymentLink['current_usage'] >= $paymentLink['max_usage']) {
// Payment link has reached maximum usage
// Consider deactivating it in your system
}