Get Merchant Keys
This endpoint allows partners to retrieve API credentials (API ID and Secret Key) for a specific sub-merchant. These credentials are necessary for sub-merchants to interact with Paylink's APIs securely.
Endpoint
GET /rest/partner/getMerchantKeys/{searchType}/{searchValue}?profileNo={profileNo}
Query Parameters
| Parameter | Value Type | Required | Description |
|---|---|---|---|
| searchType | String | Yes | Path variable for the search type |
| searchValue | String | Yes | Path variable for the search value |
| profileNo | String | Yes | 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 | 2012345678910 |
| freelancer | Freelancer document of the merchant | FL-312345678 |
| mobile | Mobile of the merchant | 0512345678 |
| E-Mail of the merchant | [email protected] | |
| accountNo | The account number of the merchant in Paylink | 31992123456789 |
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"
}
Response
The API response will be a JSON object containing the API credentials for the specified merchant.
| Field name | Field type | Description |
|---|---|---|
| id | Integer | Unique identifier for the API credentials |
| merchantId | Integer | The merchant's ID |
| merchantPhone | String | Phone number of the merchant |
| apiId | String | API ID associated with the merchant |
| secretKey | String | Secret Key associated with the merchant |
Example Response
{
"id": 761,
"merchantId": 3906,
"merchantPhone": "0512345678",
"apiId": "APP_ID_123456789",
"secretKey": "1a420f9c-4493-aaaa-9654-37cd21ea33e6"
}
Important Note
Ensure these keys are handled with care and only shared with authorized parties to maintain the security of your integrations.
Updated about 2 months ago