For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get support
HomeDocsAPI ReferenceRelease Notes
HomeDocsAPI ReferenceRelease Notes
  • Payments API
    • POSTRefresh API Keys
    • POSTCharge
    • POSTCapture
    • POSTVoid or Refund
    • POSTCheck Surcharge
    • POSTCreate Hosted Payment Page
    • PUTEdit Hosted Payment Page
    • POSTCreate Vault Payment Account
    • GETGet Vault Payment Account
    • DELDelete a Vault Payment Account
    • PUTUpdate Vault Account Details
    • POSTCreate Billing Plan
    • GETGet Billing Plan
    • DELCancel Billing Plan
  • Authentication (Reporting & Boarding)
    • POSTGet access token
  • Reporting API
    • GETGet transactions data
    • GETGet deposits data
    • GETGet chargebacks data
    • GETGet adjustments data
  • Boarding API
    • GETList merchants
    • POSTCreate a new merchant
    • GETGet a single merchant
Get support
LogoLogo

Create a new merchant

POST
https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants
POST
/ords/relay/api/boarding/v1/merchants
$curl -X POST https://apps.runpayments.io/ords/relay/api/boarding/v1/merchants \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "platform": "payroc",
>  "rep_code": "REP456",
>  "dba_name": "Green Leaf Cafe",
>  "signer_first_name": "Emily",
>  "signer_last_name": "Johnson",
>  "signer_email": "emily.johnson@greenleafcafe.com"
>}'
1{
2  "merchant_id": "mrc_8f3b2a1c9d4e7f6a"
3}

Create a new merchant in Run Partner. A successful request will return a merchant_id that can be used in subsequent API calls to retrieve updated merchant data.

Was this page helpful?
Previous

Get a single merchant

Next
Built with

Request

This endpoint expects an object.
platformenumRequired
Currently supporting Fiserv and Payroc. Additional platforms may be added in the future.
Allowed values:
rep_codestringRequired

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

dba_namestringRequired<=150 characters

Doing Business As (DBA) name.

signer_first_namestringRequired<=100 characters
First name of the signer.
signer_last_namestringRequired<=100 characters
Last name of the signer.
signer_emailstringRequired<=150 characters
Email address of the signer.
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.

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_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_phonestringOptional<=12 characters

Phone number 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_idstring
Unique identifier for the created merchant.

Errors

400
Bad Request Error
401
Unauthorized Error