Get My Merchants
The Get My Merchants API allows partners to retrieve a list of merchants associated with their account.
Endpoints
The Get My Merchants API allows partners to retrieve a list of merchants associated with their account.
Endpoint (Testing): https://restpilot.paylink.sa/rest/partner/getMyMerchants
Endpoint (Production): https://restapi.paylink.sa/rest/partner/getMyMerchants
HTTP Method: GET
Request Headers
- Authorization: Bearer token for authentication. The token should be obtained through the authentication process.
Response
The API response will be a JSON array containing information about the merchants associated with the partner's account.
Example Response
[
{
"id": 1,
"merchantId": 3906,
"merchantShopName": null,
"merchantPhone": "0599925477",
"merchantLicenseType": "freelancer",
"merchantLicenseNumber": "FL-391666498",
"merchantLicenseName": "حسن عبدالاحد ياسين ايوب",
"merchantCivilId": "1000000383",
"merchantEmail": "[email protected]",
"merchantStoreUsername": null,
"partnerProfileNo": "44841863",
"partnerLicenseName": "حسن عبدالاحد ياسين ايوب",
"currentViewer": null,
"partnerId": null,
"whoPayPaylinkFees": "merchant",
"partnerMadaFeesPercentage": 0.0,
"partnerLocalVisaFeesPercentage": null,
"partnerGulfVisaFeesPercentage": null,
"partnerGlobalVisaFeesPercentage": null,
"partnerMadaFixedFees": null,
"partnerVisaFixedFees": null,
"partnerTerminationAmount": null,
"partnerCurrentAmount": null,
"profileReferenceNo": "44841863-3906-1",
"relationshipCreationDate": 1690240524000,
"relationshipStatus": "Active",
"terminationDate": null,
"terminationNote": null
}
]
Response Properties
- id (integer): Unique identifier for the merchant.
- merchantId (integer): The merchant's ID.
- merchantShopName (string): Name of the merchant's shop (if applicable).
- merchantPhone (string): Phone number of the merchant.
- merchantLicenseType (string): Type of merchant license (e.g., freelancer).
- merchantLicenseNumber (string): License number of the merchant.
- merchantLicenseName (string): Name on the merchant's license.
- merchantCivilId (string): Civil ID of the merchant.
- merchantEmail (string): Email address of the merchant.
- merchantStoreUsername (string): Username of the merchant's store (if applicable).
- partnerProfileNo (string): Profile number of the partner associated with the merchant.
- partnerLicenseName (string): Name on the partner's license.
- currentViewer (null): Placeholder property (not in use).
- partnerId (null): Placeholder property (not in use).
- whoPayPaylinkFees (string): Indicates who pays Paylink fees, in this case, "merchant."
- partnerMadaFeesPercentage (float): Partner's Mada fees percentage.
- partnerLocalVisaFeesPercentage (null): Partner's local Visa fees percentage (not available in this response).
- partnerGulfVisaFeesPercentage (null): Partner's Gulf Visa fees percentage (not available in this response).
- partnerGlobalVisaFeesPercentage (null): Partner's global Visa fees percentage (not available in this response).
- partnerMadaFixedFees (null): Partner's Mada fixed fees (not available in this response).
- partnerVisaFixedFees (null): Partner's Visa fixed fees (not available in this response).
- partnerTerminationAmount (null): Partner's termination amount (not available in this response).
- partnerCurrentAmount (null): Partner's current amount (not available in this response).
- profileReferenceNo (string): Reference number for the merchant's profile.
- relationshipCreationDate (integer): Unix timestamp representing the date of the relationship's creation.
- relationshipStatus (string): Status of the relationship with the merchant (e.g., "Active").
- terminationDate (null): Termination date of the relationship (not available in this response).
- terminationNote (null): Termination note for the relationship (not available in this response).
Example of CURL
curl --location 'https://restpilot.paylink.sa/rest/partner/getMyMerchants' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJoYXNzYW4uYXlvdWIuMTk4MEBnbWFpbC5jb20iLCJhdXRoIjoiUk9MRV9NRVJDSEFOVCxST0xFX01FUkNIQU5UX0FDQ09VTlQsUk9MRV9QQVJUTkVSIiwiaXNzIjoiQVBJIiwiZXhwIjoxNjkyODM5Njg0fQ.ozCd819ABJicBYNa_z2BxRAdaS4uwWgI4v2NI3w2Gp3QKKbt0vCPqvlYRNxSB-vqs-Yq8EQQUB451SgWMRWSfA' \
Updated 7 months ago