View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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 22:52 UTC.

API reference Models

DuplicateCheckSettings

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Duplicate-check permissions carried on the merchant. Only `allowOverride` is live: it decides whether a single transaction request may waive the Duplicate Transaction Manager rule. The rule itself, including its window, is configured under Transaction Screening on the merchant flow configuration. The other two properties are retained for API compatibility and ignored by screening.

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
enable required boolean Retained for API compatibility and ignored by screening. Whether duplicate screening runs is decided by the Duplicate Transaction Manager rule under Transaction Screening (`Screening.Contributors.DuplicateTransaction.Enabled`), which is the configuration that applies. This value round-trips through create, update and read unchanged, and nothing reads it for a screening decision.
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.
includeInvoiceNumber required boolean Retained for API compatibility and ignored by screening. Whether the invoice number narrows the duplicate window is decided by the Duplicate Transaction Manager rule under Transaction Screening (`Screening.Contributors.DuplicateTransaction.IncludeInvoiceNumber`), which is the configuration that applies. This value round-trips through create, update and read unchanged, and nothing reads it for a screening decision.
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.
allowOverride required boolean Whether a single transaction request may waive the Duplicate Transaction Manager rule. Unlike the two settings above this one is live: it is the only duplicate-check permission carried on the merchant, and the screening rule honours it per request.
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 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.