Get a single merchant

Retrieve a detailed merchant record from Run Partner.

Path parameters

merchant_idintegerRequired
The unique identifier for the merchant

Response

Merchant retrieved successfully.
merchant_idinteger or null
Unique identifier for the merchant.
platformstring or null

Processing platform (payroc or fiserv).

rep_codestring or null
Representative code associated with the merchant.
customer_idinteger or null
Customer ID associated with the merchant.
dba_namestring or null

Doing Business As (DBA) name of the merchant.

legal_namestring or null
Legal name of the merchant.
tax_idstring or null
Tax identification number of the merchant.
years_in_businessinteger or null
Number of years the business has been operating.
websitestring or null
Business website URL.
phonestring or null
Phone number of the merchant.
mcc_codestring or null

Merchant Category Code (MCC).

business_descstring or null
Description of the business.
annual_volumeinteger or null
Annual transaction volume in dollars.
average_ticketinteger or null
Average transaction amount in dollars.
in_person_pctinteger or null

Percentage of in-person transactions.

online_pctinteger or null
Percentage of online transactions.
telephone_pctinteger or null
Percentage of telephone transactions.
ownership_typestring or null
Ownership type of the business.
merchant_statusstring or null
Current status of the merchant.
external_crm_idstring or null
External CRM system identifier.
custom_01string or null
Custom field for additional merchant data.
signer_first_namestring or null
First name of the signer.
signer_last_namestring or null
Last name of the signer.
signer_dobstring or null

Date of birth of the signer in the format mm/dd/yyyy.

signer_res_address1string or null
Residential address line 1 of the signer.
signer_res_address2string or null
Residential address line 2 of the signer.
signer_res_citystring or null
Residential city of the signer.
signer_res_statestring or null

Residential state of the signer (2-character abbreviation).

signer_res_zipstring or null
Residential ZIP code of the signer.
signer_emailstring or null
Email address of the signer.
signer_phonestring or null
Phone number of the signer.
signer_ownership_pctinteger or null
Ownership percentage of the signer.
addresseslist of objects or null
List of addresses associated with the merchant.
pricingobject or null
Pricing details for the merchant.
feesobject or null
Fee details for the merchant.
productslist of objects or null
List of products associated with the merchant.

Errors