The Partner Documentation section is dedicated to guiding partners through the integration process with Paylink's API. This section covers essential steps and details for setting up your environment, authenticating partners, registering merchants, retrieving merchant information, and handling activation notifications via webhooks. By following the guidelines provided, partners can efficiently integrate with Paylink, ensuring a seamless experience for both developers and end-users.


POST  /api/partner/register/check-nafath

Request Headers

AuthorizationYesBearer token provided by Authentication Endpoint
AcceptYesIt must be set to application/JSON.
Content-TypeYesIt must be set to application/JSON.
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"

Request Body Parameters

The request body must be a JSON object containing the following fields:

sessionUuidStringTrueThe session UUID of the registration
mobileNumberStringTrueThe mobile number of the user
partnerProfileNoStringTrueThe partner profile number

An example of the request:

  "sessionUuid": "96ea8e22-edef-414b-9724-3bd2d494b710",
  "mobileNumber": "966501234567",
  "partnerProfileNo": "12312312"

Success Response

The response will be a JSON object of type NafathResponse.

signatureStringDigital signature of the previous step
mobileStringThe mobile number
sessionUuidStringThe session UUID of the registration
nafathNumberStringThe Nafath number
statusEnum NafathStatusThe status of the Nafath
emailStringThe email of the merchant
errorMessageStringThe error message
activatingAccountResponseActivatingAccountResponseThe response of the activating account

Example of the response:

  "signature": "ae135f2506dc3c44152d62265419c09e****",
  "mobile": "00966512345678",
  "sessionUuid": "96ea8e22-edef-414b-9724-3bd2d494b710",
  "nafathNumber": "26",
  "status": "Waiting",
  "email": "[email protected]",
  "errorMessage": null,
  "activatingAccountResponse": null

NafathStatus Enum

The NafathStatus enum represents the possible statuses of the Nafath account:

WAITINGThe request is waiting for processing
COMPLETEDThe request has been completed successfully
EXPIREDThe request has expired
REJECTEDThe request has been rejected
ERRORThere was an error processing the request

HTTP Status Codes

  • 200 OK: The Nafath account status was successfully checked.
  • 400 Bad Request: The request body is invalid or missing required fields.
  • 401 Unauthorized: The user is not authorized to perform this action.
  • 500 Internal Server Error: An unexpected error occurred on the server.