This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 23:35 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Time of Day Restriction configuration: the hours, and optionally the days, during which this
merchant expects transactions.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
enabledrequired
boolean
Whether this rule runs. False, the default, means the rule is skipped and never flags a
transaction. A rule that is enabled but has no usable settings also screens nothing.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
What happens when this rule flags a transaction. `AuditOnly`, the default, records the
detection and lets the transaction continue. `Stop` halts the transaction before
authorization, and the caller receives HTTP 403 with the error code
`SCREENING_STOPPED`. `HoldForReview` parks the transaction on the fraud review
queue until a reviewer approves or declines it, or the merchant's hold deadline passes.
Whatever the action, the verdict is recorded on the transaction.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
The allowed window. Null leaves the rule unconfigured, which screens nothing.
Required: When Enabled is true.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of TimeOfDayRestrictionSettings:
Field
Type
Description
allowedStartMinuterequired
integer (int32)
Start of the allowed window, in minutes after midnight in `timeZoneId`; the
start minute is inside the window. For example 480 is 8:00. Accepted range 0 to 1439.
Required, with `allowedEndMinute` and `timeZoneId`, when the rule is
enabled.nullablemin 0max 1439
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowedEndMinuterequired
integer (int32)
End of the allowed window, in minutes after midnight in `timeZoneId`; the end
minute is outside the window. An end earlier than the start describes a window that crosses
midnight, so a start of 1320 and an end of 360 allows 22:00 to 6:00. Accepted range 0 to
1439, and must differ from `allowedStartMinute`.nullablemin 0max 1439
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowedDaysOfWeekrequired
string
Comma-separated English day names the window applies on, for example
`Monday,Tuesday,Wednesday,Thursday,Friday`. A transaction created on any other day is
flagged. The day is the day on which the window starts, so a window crossing midnight that
starts on Friday covers the early hours of Saturday. Null or blank allows every day.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
timeZoneIdrequired
string
The IANA time zone the window is expressed in, for example `America/Chicago`. Required
when the rule is enabled. Daylight saving time is applied automatically.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.