API Reference
  1. PCE Boarding APIs
  2. Businesses

Create a business

post
https://sandbox-api.prioritycommerce.com/v1/businesses

Creates a business. You can send every detail in one request, including owners, signatories, bank accounts, locations, services and documents, or send only legalName and complete the business later.

The response shows the new business and the status of each requested service. If anything is still needed, it is listed in services.payin.card.missingFields, missingDocuments and errors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of the business to create. Only legalName is required to create the business; the other fields can be sent now or later.

string
length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

string
required

The full legal name of the business, exactly as registered with the government.

string
length ≤ 150

The name customers know the business by, also called the DBA ("doing business as") name. Up to 150 characters.

string
enum

The legal structure of the business. Values are not case-sensitive, and common alternatives are accepted, for example corporation for c_corporation or tax_exempt for tax_exempt_501c3. Needed to activate card processing (payin.card).

string
length ≤ 512

A short description of what the business sells or does, up to 512 characters. Needed to activate card processing (payin.card).

string
length ≤ 512

The website of the business, up to 512 characters.

string

Main contact email address.

string
^\+[1-9]\d{1,14}$

Main contact phone number in international E.164 format: a +, the country code, then the number, with no spaces. Example: +15125550142.

string
length ≤ 50

The name the business uses on its tax filings, if different from legalName. Up to 50 characters.

taxIds
array of objects

Tax identification numbers of the business. Send one primary tax ID. Needed to activate card processing (payin.card).

taxIds
incorporations
object

Where and when the business was legally formed. Needed to activate card processing (payin.card).

addresses
array of objects

Addresses of the business. Include the registered address. Needed to activate card processing (payin.card).

addresses
owners
array of objects

People who own part of the business or control it. Include every person who owns 25% or more. Exactly one owner or signatory must be the control person, and a business can have up to five owners and signatories combined. Needed to activate card processing (payin.card).

owners
signatories
array of objects

People authorized to sign on behalf of the business.

signatories
bankAccounts
array of objects

Bank accounts for receiving settlement funds and paying fees. At least one is needed. Needed to activate card processing (payin.card).

bankAccounts
locations
array of objects

Places where the business accepts payments. At least one is needed. Needed to activate card processing (payin.card).

locations
documents
array of objects

Documents from your document library to attach, such as the signed merchant agreement. The merchant agreement is needed to activate card processing (payin.card).

documents
services
object

Services to enable for the business, such as card processing, and their optional features.

Headers
string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

Updated about 19 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 19 hours ago

Did this page help you?
.readme-logo { display: none !important; }