Skip to main content

Location

merchantIdOpaqueIdrequired

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

locationIdOpaqueId

Alias of merchantId at the location API boundary.

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

organizationIdOpaqueId

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

businessNamestringrequired
externalIdstring
dbastring
mccstring
contactNamestring
contactEmailstring<email>
contactPhonestring
address object
streetstring
citystring
statestring
zipstring
countrystring
logoUrlstring<uri>
primaryColorstring
webhookUrlstring<uri>
googlePayMerchantIdstring
metadata object
property name*any
defaultCurrencystringrequired
Example: USD
supportedCurrenciesstring[]
statusLocationStatusrequired

Possible values: [PENDING, ACTIVE, SUSPENDED, INACTIVE]

createdAtstring<date-time>required
updatedAtstring<date-time>required
Location
{
"merchantId": "string",
"locationId": "string",
"organizationId": "string",
"businessName": "string",
"externalId": "string",
"dba": "string",
"mcc": "string",
"contactName": "string",
"contactEmail": "user@example.com",
"contactPhone": "string",
"address": {
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"logoUrl": "string",
"primaryColor": "string",
"webhookUrl": "string",
"googlePayMerchantId": "string",
"metadata": {},
"defaultCurrency": "USD",
"supportedCurrencies": [
"string"
],
"status": "PENDING",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z"
}