API Reference
  1. PCE Boarding APIs
  2. Business Locations

Add a location

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

Adds a location to a business. A location is where the business accepts payments. Card processing is set up for every location, so each one needs its own address, phone number, processing profile and industry code.

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

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

Body Params

A location where the business accepts payments.

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
length ≤ 200

Name of the location as customers see it, for example the store name. Up to 200 characters.

boolean

Set to true for the main location of the business.

address
object
required

Street address of the location.

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

Phone number of the location in international E.164 format, for example +15125550187. Needed to activate card processing (payin.card).

string

Contact email address for the location.

string
length ≤ 512

Website for the location, up to 512 characters.

processingProfile
object

How the location expects to take payments. Needed to activate card processing (payin.card).

operational
object

When the location is open for business. Needed to activate card processing (payin.card).

industry
object

The type of business carried out at the location. Needed to activate card processing (payin.card).

services
object

Service settings for this location only. Leave empty to use the business settings.

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; }