Create a merchant location

Creates a physical location on the merchant and appends its id to the merchant's locations index. name, address, mcc and phone are required and are stored exactly as supplied — a location never inherits the merchant's own values. If bankingId is supplied it must reference an existing bank account on this merchant, otherwise the request is rejected with HTTP 400.

Path Params
string
required

The Preczn merchant to attach the location to.

Body Params
string
required
length between 1 and 255

Human-readable name for the location.

address
object
required

Physical address of the location.

string
required
length between 1 and 4

Merchant category code for this location.

string
required
length between 1 and 14

Location phone in strict E164 format (+1XXXXXXXXXX).

string | null

Id of the merchant banking[] entry funding this location. Omit or send null for no assigned account.

Responses

401

Unauthorized (test-mode mismatch).

403

Forbidden (platform mismatch).

404

Merchant not found.

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