Payment Webhook
Paylink provides a webhook service that notifies merchants when an order is paid. This documentation outlines the setup, structure, and usage of the webhook service.
Prerequisites
To use this webhook service, the merchant must be a registered partner with Paylink. Please contact Paylink customer service to discuss partnership details.
Request Type
- Method: POST
Endpoint Setup
Merchants need to set up the webhook endpoint in the My Paylink Portal. This can be done on the settings page, as shown in the following screenshot:
Authorization
If any special authorization is required for the webhook request, the developer can include it in the header fields. For example:
{
"Authorization": "Bearer [token]"
}
Paylink will include the authorization header in the webhook call.
Request Body
The webhook will send a JSON object containing all relevant information about the paid order. The structure of the JSON object is as follows:
Parameter | Type | Description |
---|---|---|
amount | float | The total amount of the order. |
merchantEmail | string | The email address of the merchant. |
transactionNo | string | The transaction number generated by Paylink. |
merchantOrderNumber | string | The order number assigned by the merchant. |
orderStatus | string | The status of the order (e.g., "Paid"). |
Example request body:
{
"amount": 150.0,
"merchantEmail": "[email protected]",
"transactionNo": "167845623412",
"merchantOrderNumber": "ORD789012",
"orderStatus": "Paid"
}
Expected Response
- HTTP Status Code: 200
The merchant's system is expected to respond with a 200 HTTP status code to acknowledge the receipt of the webhook.
Error Handling
If the webhook is not acknowledged with a 200 HTTP status code, Paylink will retry sending the webhook ten times at intervals.
Updated about 2 hours ago