Upsert Merchant

post

https://app.getmatchifi.com/api/merchant

Create a merchant or update an existing merchant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Send a JSON object. Unknown properties are ignored. Values must match the documented types.

name

string

length ≥ 1

Merchant/company name. Required when creating a merchant; optional on updates. Omit on updates to preserve the existing name. If supplied, must be a nonempty string.

appID

string

required

length ≥ 1

Globally unique merchant identifier and merchant link identifier. Existing merchants are updated only when they belong to the authenticated property; another property's appID returns 409.

lenderIDs

object

Lender merchant identifiers and credentials. On updates, omitting this object or sending {} preserves existing values. Only explicitly supplied keys are updated; omitted keys remain unchanged. Values must be strings, not null. An empty string is accepted and replaces the stored value. Creation without IDs stores null IDs.

disabledLenders

object

Per-merchant lender disable flags. true disables a lender; false clears its disable flag. On updates, omitted objects and keys preserve existing values, including when {} is supplied. Clearing a disable flag does not guarantee financing eligibility.

active

boolean

Whether the merchant is active. Defaults to true on creation. Omit on updates to preserve the stored value.

archived

boolean

Whether the merchant is archived. Defaults to false on creation. Omit on updates to preserve the existing value.

address

object | null

Omit to preserve an existing address. Supply null to delete an existing address; on creation, null creates no address. Supply an object to create or update the address; streetAddress, city, state and zip are all required whenever an object is supplied. An omitted streetAddress2 is preserved when updating an existing address.

demo

boolean

Sets the merchant demo-account flag. Defaults to false on creation. Omit on updates to preserve the stored value. Not included in the response.

enrollmentInfo

object

Optional merchant enrollment information, not included in the response. ownerInfo and businessInfo are optional; each must satisfy its full schema when supplied. Supplied owner and business details update the corresponding enrollment information.

Responses

200Merchant created or updated. A successful response does not guarantee financing eligibility.

401Missing/invalid property token, or invalid request body. This endpoint uses 401 for body-validation failures as well as authentication failures.

405Unsupported HTTP method. The /api/merchant route supports GET for listing and POST for upserting.

409The appID already belongs to a different property. The existing merchant is not updated.

422Unable to complete lender setup. Merchant changes have been saved despite this error.

500Unable to complete the request. Merchant changes may already have been saved.