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. connectionData is optional per-connection configuration: at most one entry per processor, whose value must be a recognised processor name. Entry ids are server-minted — supplying one on create returns HTTP 400. Entries for Preczn-managed processors (currently AdyenForPlatforms) are written by Preczn, not by clients: supplying one returns HTTP 400. The merchant does NOT need an existing connection for that processor, since these values are an input to boarding rather than a result of it.

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
^\d{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.

connectionData
array of objects

Per-connection configuration for this location, at most one entry per processor. Do NOT supply entry ids on create. They are server-minted. Entries for Preczn-managed processors (currently AdyenForPlatforms) cannot be supplied: such an entry is rejected with HTTP 400. Each connection adds its own fields at the root of its entry. Jack Henry requires five ACH limit fields on every location: debitSingleTransAmount, debitSingleDayCount, debitSingleDayAmount, debitPeriodCount, and debitPeriodAmount. Each is a whole number; amounts are in whole dollars, and the period is two weeks. See the Jack Henry connection guide at https://docs.preczn.com/docs/jack-henry.

connectionData
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