Get My Merchants

Endpoint

GET /rest/partner/getMyMerchants

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 array containing information about the merchants associated with the partner's account.

Field name	Field type	Description
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		Placeholder property (not in use).
partnerId		Placeholder property (not in use).
whoPayPaylinkFees	String	Indicates who pays Paylink fees, in this case, "merchant".
partnerMadaFeesPercentage	Float	Partner's Mada fees percentage.
partnerLocalVisaFeesPercentage		Partner's local Visa fees percentage (not available in this response).
partnerGulfVisaFeesPercentage		Partner's Gulf Visa fees percentage (not available in this response).
partnerGlobalVisaFeesPercentage		Partner's global Visa fees percentage (not available in this response).
partnerMadaFixedFees		Partner's Mada fixed fees (not available in this response).
partnerVisaFixedFees		Partner's Visa fixed fees (not available in this response).
partnerTerminationAmount		Partner's termination amount (not available in this response).
partnerCurrentAmount		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		Termination date of the relationship (not available in this response).
terminationNote		Termination note for the relationship (not available in this response).

Example of the response:

[
  {
    "id": 1,
    "merchantId": 3906,
    "merchantShopName": null,
    "merchantPhone": "0512345678",
    "merchantLicenseType": "freelancer",
    "merchantLicenseNumber": "FL-12345678",
    "merchantLicenseName": "Ahmed Ali Mohammed",
    "merchantCivilId": "1012345678",
    "merchantEmail": "[email protected]",
    "merchantStoreUsername": null,
    "partnerProfileNo": "412345678",
    "partnerLicenseName": "Ahmed Ali Mohammed",
    "currentViewer": null,
    "partnerId": null,
    "whoPayPaylinkFees": "merchant",
    "partnerMadaFeesPercentage": 0.0,
    "partnerLocalVisaFeesPercentage": null,
    "partnerGulfVisaFeesPercentage": null,
    "partnerGlobalVisaFeesPercentage": null,
    "partnerMadaFixedFees": null,
    "partnerVisaFixedFees": null,
    "partnerTerminationAmount": null,
    "partnerCurrentAmount": null,
    "profileReferenceNo": "412345678-3906-1",
    "relationshipCreationDate": 1690240524000,
    "relationshipStatus": "Active",
    "terminationDate": null,
    "terminationNote": null
  }
]