Skip to main content

Class GetAllMerchantsRequest

Get All Merchants will retrieve a list of all your merchants, merchant IDs (MIDs), locations associated with the merchants and their location IDs (LIDs), if they are enabled or disabled, and when they were created on the EPS system. When entering the date, this action will only retrieve the list of merchants that were enabled or disabled within 90-day increments to eliminate timeouts and performance issues.

Properties

Field/Tag NameValueRequiredNotes
custServProviderIdYPartner Id
request_emailYRegistered at ProfitStars; email format
merchant_enabledAll, Enabled, DisabledYalphanumeric; (case sensitive)
begin_dateYformat yyyy-MM-dd -- within last 90 days
end_dateYformat yyyy-MM-dd -- within last 90 days

Example GetAllMerchantsRequest

Input Method: XML

<xml> 
<request_email>none@example.com</request_email>
<custServProviderId>######</custServProviderId>
<merchant_enabled>All</merchant_enabled>
<begin_date>yyyy-mm-dd</begin_date>
<end_date>yyyy-mm-dd</end_date>
</xml>