Paylink Partner API - Get Merchant Keys

Overview

The Get Merchant Keys API allows partners to retrieve API credentials (App ID and Secret Key) for a specific sub-merchant.

Endpoint (Testing): https://restpilot.paylink.sa/rest/partner/getMerchantKeys/{searchType}/{searchValue}?profileNo={profileNo}

Endpoint (Production): https://restapi.paylink.sa/rest/partner/getMerchantKeys/{searchType}/{searchValue}?profileNo={profileNo}

HTTP Method: GET

Request URL Parameters

searchType (string): Path variable for the search type.
searchValue (string): Path variable for the search value.
profileNo (string): Profile number of the partner associated with the merchant.

The following table gives more information about the parameters searchType and searchValue:

searchType	Description	searchValue (example)
cr	Commercial Registration of the merchant	20139202930
freelancer	Freelancer document of the merchant	FL-391666498
mobile	Mobile of the merchant	0509200900
email	E-Mail of the merchant	[email protected]
accountNo	The account number of the merchant in Paylink	3199210810102450

Request Headers

Authorization: Bearer token for authentication. The token should be obtained through the authentication process.

Response

The API response will be a JSON object containing the API credentials (App ID and Secret Key) for the specified merchant.

Example Response

{
    "id": 761,
    "merchantId": 3906,
    "merchantPhone": "0512925477",
    "apiId": "APP_ID_1690252194771",
    "secretKey": "1a420f9c-4493-4f1a-9654-37cd21ea33e6"
}

Response Properties

id (integer): Unique identifier for the API credentials.
merchantId (integer): The merchant's ID.
merchantPhone (string): Phone number of the merchant.
apiId (string): App ID associated with the merchant.
secretKey (string): Secret Key associated with the merchant.

Example CURL

curl --location 'https://restpilot.paylink.sa/rest/partner/getMerchantKeys/freelancer/FL-391666498?profileNo=44841863' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJoYXNzYW4uYXlvdWIuMTk4MEBnbWFpbC5jb20iLCJhdXRoIjoiUk9MRV9NRVJDSEFOVCxST0xFX01FUkNIQU5UX0FDQ09VTlQsUk9MRV9QQVJUTkVSIiwiaXNzIjoiQVBJIiwiZXhwIjoxNjkyODM5Njg0fQ.ozCd819ABJicBYNa_z2BxRAdaS4uwWgI4v2NI3w2Gp3QKKbt0vCPqvlYRNxSB-vqs-Yq8EQQUB451SgWMRWSfA'