Archive Merchant API

This API endpoint lets you archive a merchant using a specific key, like a mobile number.

🚧

This endpoint only work in testing environment.

Endpoint:

Testing Env:

https://restpilot.paylink.sa/rest/partner/test/archive-merchant/{partnerProfileNo}

HTTP Method:

POST

Headers:

HeaderRequiredDescription
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"
}

Body:

The request body is a JSON object with two key-value pairs:

key: This is the actual value like a mobile number.
keyType: Type of the key being passed, e.g., mobile.

Possible values of keyType:

  • email: the email of the sub-merchant.
  • cr: The commercial registration of the merchant.
  • mobile: The mobile number of the merchant.

Example

{
    "key":"[KEY_VALUE]",
    "keyType":"[KEY_TYPE]"
}

CURL Command:

curl --location 'https://restpilot.paylink.sa/rest/partner/test/archive-merchant/[PROFILE_ID]' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer [BEARER_TOKEN]' \
--data '{
    "key":"[KEY_VALUE]",
    "keyType":"[KEY_TYPE]"
}'

Placeholder:

Placeholders:
[PROFILE_ID]: Replace this with the specific partner profile ID you wish to archive.
[BEARER_TOKEN]: Replace with your actual Bearer token taken from Partner Auth.
[KEY_VALUE]: Replace with the actual key value, like a mobile number.
[KEY_TYPE]: Replace with the type of the key. Values are: [email, cr, freelancer, mobile, orderNumber, accountNo].