Boarding API

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_iddoubleOptional

Unique identifier for the merchant.

merchant_statusstringOptional<=25 characters

See merchant_status for possible values.

platformstringOptional<=25 characters

Either payroc or fiserv.

rep_codestringOptional<=15 characters

Representative code associated with the merchant.

customer_iddoubleOptional

Customer ID associated with the merchant.

fee_template_iddoubleOptional

Fee template ID used for the merchant.

dba_namestringOptional<=150 characters

Doing Business As (DBA) name of the merchant.

legal_namestringOptional<=150 characters

Legal name of the merchant.

tax_idstringOptional<=12 characters

Tax identification number of the merchant.

years_in_businessdoubleOptional

Number of years the business has been operating.

websitestringOptional<=250 characters

Business website URL.

phonestringOptional<=12 characters

Phone number of the merchant.

mcc_codestringOptional<=4 characters

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

business_descstringOptional<=400 characters

Description of the business.

when_card_chargedenumOptional

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

Allowed values:
services_provided_inenumOptional

Timeframe for when services or goods are provided.

Allowed values:
refund_policyenumOptional

Refund policy. Must be one of the listed values.

Allowed values:
seasonalbooleanOptional

Indicates if the business is seasonal.

seasonal_monthsstringOptional<=30 characters

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

annual_volumedoubleOptional

Annual transaction volume in dollars.

average_ticketdoubleOptional

Average transaction amount in dollars.

in_person_pctdoubleOptional

Percentage of in-person transactions.

online_pctdoubleOptional

Percentage of online transactions.

telephone_pctdoubleOptional

Percentage of telephone transactions.

ownership_typestringOptional

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_namestringOptional<=100 characters

First name of the signer.

signer_last_namestringOptional<=100 characters

Last name of the signer.

signer_dobstringOptionalformat: "date"

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

signer_res_address1stringOptional<=150 characters

Residential address line 1 of the signer.

signer_res_address2stringOptional<=150 characters

Residential address line 2 of the signer.

signer_res_citystringOptional<=150 characters

Residential city of the signer.

signer_res_statestringOptional<=2 characters

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

signer_res_zipstringOptional<=10 characters

Residential ZIP code of the signer.

signer_emailstringOptional<=150 characters

Email address of the signer.

signer_phonestringOptional<=12 characters

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

signer_ownership_pctdoubleOptional

Ownership percentage of the signer.

addresseslist of objectsOptional

List of addresses associated with the merchant.

pricingobjectOptional

Pricing details for the merchant.

feesobjectOptional

Fee details for the merchant.

productslist of objectsOptional

List of products associated with the merchant.

Errors