Get a single merchant

Use the GET method to retrieve a merchant record from Run Partner. A successful request will return the merchant ID that can be used in subsequent API calls to retrieve merchant data.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Merchant retrieved successfully.
merchant_iddouble or null
Unique identifier for the merchant.
merchant_statusstring or null<=25 characters

See merchant_status for possible values.

platformstring or null<=25 characters

Either payroc or fiserv.

rep_codestring or null<=15 characters
Representative code associated with the merchant.
customer_iddouble or null
Customer ID associated with the merchant.
fee_template_iddouble or null
Fee template ID used for the merchant.
dba_namestring or null<=150 characters

Doing Business As (DBA) name of the merchant.

legal_namestring or null<=150 characters
Legal name of the merchant.
tax_idstring or null<=12 characters
Tax identification number of the merchant.
years_in_businessdouble or null
Number of years the business has been operating.
websitestring or null<=250 characters
Business website URL.
phonestring or null<=12 characters
Phone number of the merchant.
mcc_codestring or null<=4 characters

Merchant Category Code (MCC). See /mcc for valid values.

business_descstring or null<=400 characters
Description of the business.
when_card_chargedenum or null

When the card is charged. Must be one of in_advance or on_delivery.

Allowed values:
services_provided_inenum or null
Timeframe for when services or goods are provided.
Allowed values:
refund_policyenum or null
Refund policy. Must be one of the listed values.
Allowed values:
seasonalboolean or null
Indicates if the business is seasonal.
seasonal_monthsstring or null<=30 characters

Colon-delimited month numbers (e.g., 1:2:10 for January, February, and October).

annual_volumedouble or null
Annual transaction volume in dollars.
average_ticketdouble or null
Average transaction amount in dollars.
in_person_pctdouble or null

Percentage of in-person transactions.

online_pctdouble or null
Percentage of online transactions.
telephone_pctdouble or null
Percentage of telephone transactions.
ownership_typestring or null

Ownership type of the business. Fiserv: Must be one of llc, sole_proprietor, government, not_for_profit, partnership, tax_exempt, public_corp, private_corp. Payroc: Must be one of llc, sole_proprietor, government, not_for_profit, partnership, s_corp, c_corp, other.

signer_first_namestring or null<=100 characters
First name of the signer.
signer_last_namestring or null<=100 characters
Last name of the signer.
signer_dobstring or nullformat: "date"

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

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

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

signer_res_zipstring or null<=10 characters
Residential ZIP code of the signer.
signer_emailstring or null<=150 characters
Email address of the signer.
signer_phonestring or null<=12 characters

Phone number of the signer in the format ###-###-####.

signer_ownership_pctdouble 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