5. Activation Webhook

When a merchant registers with Paylink via the Partner Registration API, they undergo either instance activation or normal activation. This webhook is triggered upon the merchant's activation or rejection by Paylink.

Suggest Edits

Request Type

Method: POST

Endpoint Setup

Partner 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 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
}

Expected Response

HTTP Status Code: 200

The partner'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 2 months ago