Create a location on the form's merchant

post

https://api.preczn.com/v1/forms/{formId}/locations

Form-scoped equivalent of POST /v1/merchants/:merchantId/locations. Resolves the merchant from the form record then delegates to LocationApiService: name, address, mcc and phone are required and stored exactly as supplied; a location never inherits the merchant's own values. bankingId, when supplied, must reference a bank account on this merchant (400 otherwise). RETRY SAFETY: send an idempotency-key header, generated once per new location and reused on retry — a retried request after a timeout returns the original 201 with the same location id instead of creating a duplicate. Without the header no replay protection is applied.

Path Params

formId

string

required

The boarding form id.

Body Params

name

string

required

length between 1 and 255

Human-readable name for the location.

address

object

required

Physical address of the location.

mcc

string

required

length between 1 and 4

^\d{4}$

Merchant category code for this location.

phone

string

required

length between 1 and 14

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

bankingId

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

Headers

idempotency-key

string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

400

Validation failure, bankingId does not match a bank account on this merchant, or the form has expired ({ expirationUrl }).

404

Form or merchant not found.

201Location created.