Skip to main content

Location payment methods validation rules for accepted payment types and configuration requirements

Change Detection​

CountOfPaymentMethodsIncreased​

DefinitionSeverityAPISampleMode
Validate that the count of paymentMethods values in latest submittal is less than or matches the count in the store record
INFO
PUT
A

SuspiciousRemovalOfPaymentMethods​

DefinitionSeverityAPISampleMode
Validate that paymentMethods is present when previously submitted
WARNING
PUT
S

Payment Methods​

PaymentMethodsListMustNotIncludeNulls​

DefinitionSeverityAPISampleMode
Validate that a list does not include null
VIOLATION
POST_AND_PUT
S

PaymentMethodsMustNotBeEmptyArray​

DefinitionSeverityAPISampleMode
Validate that paymentMethods is not an empty array
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__PaymentMethodsMustNotBeEmptyArray",
"message": "'{{field}}' must be omitted or contain at least one element; empty arrays are not allowed.",
"severity": "VIOLATION",
"context": {
"field": "paymentMethods"
},
"details": {
"compared": [],
"expected": [],
"submitted": [
{
"field": "$.locationDetails.paymentMethods",
"value": "[]"
}
],
"createdDate": "2026-03-03T13:58:43.946Z"
}
}

PaymentMethodsMustBeDistinct​

DefinitionSeverityAPISampleMode
Validate that each paymentMethods value is distinct
VIOLATION
POST_AND_PUT
S

PaymentMethodsMustBeValid​

DefinitionSeverityAPISampleMode
Validate that each paymentMethods value is valid
VIOLATION
POST_AND_PUT
Link
S

PaymentMethodsMustNotBeEmpty​

DefinitionSeverityAPISampleMode
Validate that paymentMethods is not an empty string
VIOLATION
POST_AND_PUT
S