Update a location (partial)

patch

https://api.preczn.com/v1/merchants/{merchantId}/locations/{locationId}

Partial update of a single location row — NOT a full-array replace. An omitted field keeps its stored value; a provided field replaces it. The core embedded fields (name, address and its sub-fields, mcc, phone) may not be set to null: a location's site facts are always concrete, so there is no "clear back to inherited" and a null is rejected with HTTP 400. bankingId is the one nullable field — send a valid account id to assign (re-validated against the merchant's banking[] exactly as create does), or null to clear the assignment. primaryLocationId is NOT settable here; it lives on the merchant PATCH, and sending it — or any other unrecognized field — returns 400 rather than being silently ignored. connectionData is the one ID-ANCHORED REPLACEMENT field: the array you send is the desired end state of the client-written entries. An entry carrying an id updates that stored entry, an entry without one is created, and ANY STORED CLIENT-WRITTEN ENTRY WHOSE ID YOU OMIT IS DELETED. Send [] to remove every client-written entry; null is rejected. An id that does not belong to this location returns HTTP 400 naming the offending id(s). Entries for Preczn-managed processors (currently AdyenForPlatforms) are outside that replacement: they are always kept, whatever array you send, and they are returned in the response. Leave them out when sending the array back — an entry naming a Preczn-managed processor returns HTTP 400, and a Preczn-managed entry's id cannot be addressed (it is reported as not found on this location).

Path Params

merchantId

string

required

locationId

string

required

Body Params

name

string

length ≤ 255

Human-readable name for the location. May not be cleared to null.

address

object

Physical address of the location. May not be cleared to null.

mcc

string

length ≤ 4

Merchant category code for this location. May not be cleared to null.

phone

string

length ≤ 14

Location phone in strict E164 format (+1XXXXXXXXXX). May not be cleared to null.

bankingId

string | null

Id of the merchant banking[] entry funding this location. Send null to clear the assignment.

connectionData

array of objects

Per-connection configuration. ID-ANCHORED REPLACEMENT: the array sent is the desired end state of the client-written entries. An entry with an id updates that entry, an entry without one is created, and any stored client-written entry whose id is absent from the array is DELETED. May not be cleared to null; send [] to remove all client-written entries. Entries for Preczn-managed processors (currently AdyenForPlatforms) cannot be supplied (HTTP 400) and are kept when omitted. They may appear in responses, so leave them out when sending the array back. 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, or location not found on this merchant.

200Location updated.

400Validation failure, an unrecognized field, a null core field, a bankingId that does not match a bank account on this merchant, or a connectionData entry naming an unknown processor, repeating a processor, carrying an id not found on this location, or naming a Preczn-managed processor.