Activation Webhook

Any merchant registering to Paylink via Partner Registration API will go through either instance activation or normal activation. This webhook will trigger when the merchant is either activated or rejected by Paylink. The webhook subscriber will receive a JSON object in the POST request body, following the above structure.

The webhook object contains information about the new merchant, including email, mobile, civilId, licenseType, licenseName, licenseNumber, status, and errorMsg (if any).

Register

Merchant has to be a partner to use this webhook service. Call customer service to discuss the partnership with Paylink.

Request Type:

POST

Endpoint

Merchant has to set up the webhook in the https://my.paylink.sa portal. The setup is on the settings page, as appears in the following screenshot:

If any special authorization is needed for the Webhook request, the developer can set it in the headers fields—for example, Authorization: Bearer susdyfasdoifyaoifuasdfoisdufoisfdoicoivucoibucoibucoiuoiu.

Paylink will include it during the webhook call.

Request Body:

The request will contain the JSON object that includes all relevant information for the settlement. For example:

{
   "profileNo": "44841863",
   "email": "[email protected]",
   "mobile": "0555631171",
   "civilId": "1031234567",
   "licenseType": "cr",
   "licenseName": "شركة",
   "licenseNumber": "2001234123",
   "status": "Approved",
   "errorMsg": null
}

Response

The paylink system expects to receive 200 HTTP code responses to ensure the webhook reaches the merchant system. Otherwise, Paylink will try and keep sending the same webhook another ten times.