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:
POST /rest/partner/test/archive-merchant/{partnerProfileNo}Query Parameters
| Parameter | Value Type | Description |
|---|---|---|
| partnerProfileNo | String | The specific partner profile ID you wish to archive |
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer token provided by Authentication Endpoint |
| Accept | Yes | It must be set to application/JSON. |
| Content-Type | Yes | It must be set to application/JSON. |
{
"Authorization": "Bearer [id_token]",
"Accept": "application/json",
"Content-Type": "application/json"
}Request Body Parameters
| Field name | Field type | Description |
|---|---|---|
| keyType | String | Type of the key being passed: |
| key | String | This is the actual value like a mobile number |
Possible values of keyType
keyType| Value | Description |
|---|---|
| The email of the sub-merchant. | |
| cr | The commercial registration of the merchant. |
| freelancer | Freelancer document of the merchant |
| mobile | The mobile number of the merchant. |
| orderNumber | The order number is in the system of the merchant. |
| accountNo | The account number of the merchant in Paylink |
An example of the request is as follows:
{
"keyType": "email",
"key": "[email protected]"
}Updated about 2 months ago
