Get a single merchant

Retrieve a detailed merchant record from Run Partner.

Authentication

AuthorizationBearer
This API uses OAuth 2.0 for authentication.

Path parameters

merchant_idintegerRequired
The unique identifier for the merchant

Response

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

Processing platform (payroc or fiserv).

rep_codestring
Representative code associated with the merchant.
dba_namestring

Doing Business As (DBA) name of the merchant.

merchant_statusstring

Current status of the merchant (e.g., new, sent_for_signature, signed, in_underwriting, boarded, live, cancelled, declined, unknown).

addresseslist of objects
List of addresses associated with the merchant.
feesobject
Fee details for the merchant.
productslist of objects
List of products associated with the merchant.
sales_office_namestring or nullOptional
Name of the sales office associated with the rep code.
sales_office_idinteger or nullOptional
ID of the sales office associated with the rep code.
customer_idinteger or nullOptional
Customer ID associated with the merchant.
legal_namestring or nullOptional
Legal name of the merchant.
tax_idstring or nullOptional
Tax identification number of the merchant.
years_in_businessinteger or nullOptional
Number of years the business has been operating.
websitestring or nullOptional
Business website URL.
phonestring or nullOptional
Phone number of the merchant.
mcc_codestring or nullOptional

Merchant Category Code (MCC).

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

Percentage of in-person transactions.

online_pctinteger or nullOptional
Percentage of online transactions.
telephone_pctinteger or nullOptional
Percentage of telephone transactions.
ownership_typestring or nullOptional
Ownership type of the business.
fee_template_idinteger or nullOptional
ID of the fee template applied to the merchant, if any.
external_crm_idstring or nullOptional
External CRM system identifier.
custom_01string or nullOptional
Custom field for additional merchant data.
signer_first_namestringOptional
First name of the signer.
signer_last_namestringOptional
Last name of the signer.
signer_dobstring or nullOptional

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

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

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

signer_res_zipstring or nullOptional
Residential ZIP code of the signer.
signer_emailstringOptional
Email address of the signer.
signer_phonestring or nullOptional
Phone number of the signer.
signer_ownership_pctintegerOptional
Ownership percentage of the signer.
pricingobjectOptional
Pricing details for the merchant.

Errors

401
Unauthorized Error
404
Not Found Error