Boarding API

Create a new merchant

Use the POST method to create a new merchant in 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.

Request

This endpoint expects an object.
platformenumOptional

Currently supporting Fiserv and Payroc. Additional platforms may be added in the future.

Allowed values:
rep_codestringOptional

Must be a rep_code that exists on your account. See the /rep_codes endpoint.

customer_iddoubleOptional

Used if adding to an existing account.

application_template_iddoubleOptional

ID of the application template to use. If provided, pricing, fees, and products are ignored.

dba_namestringOptional<=150 characters

Doing Business As (DBA) name.

legal_namestringOptional<=150 characters

Legal name of the business.

tax_idstringOptional<=12 characters

Tax identification number.

years_in_businessdoubleOptional

Number of years the business has been operating.

websitestringOptional<=250 characters

Business website URL.

phonestringOptional<=12 characters

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

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.

Allowed values:
services_provided_inenumOptional

Timeframe for when services or goods are provided.

Allowed values:
refund_policyenumOptional

Refund policy.

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). Required if seasonal is true.

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_typeenumOptional

Additional platform-specific ownership types:
Fiserv - tax_exempt, public_corp, private_corp.
Payroc - s_corp, c_corp, other.

Allowed values:
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.

Response

Merchant created successfully.

merchant_idstringOptional

Unique identifier for the created merchant.

Errors