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

FraudReviewData

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

Durable record of a transaction held for manual fraud review: when the hold started, when it expires, what triggered it, and the disposition a human (or the expiry sweep) eventually reached.

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
heldAtUtc required string (date-time) UTC instant the transaction was parked for review. Stamped once by the screening stage. 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.
deadlineUtc required string (date-time) UTC instant by which a `Pending` hold must be resolved before the expiry sweep dispositions it on the merchant's behalf. 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.
triggeringProviderId required string Identifier of the screening provider whose verdict triggered the hold, matching `ExternalScreeningResult.ProviderId`. `null` when the hold came from a platform rule rather than an external provider. 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.
triggeringProviderName required string Display name of the triggering provider as it stood at park time, snapshotted so the record still reads correctly after the merchant renames or removes the profile. 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.
score required number (double) The normalized risk score that drove the hold, when the trigger reported one. 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.
disposition required FraudReviewDisposition FraudReviewDisposition Where the hold currently sits in its disposition lifecycle. 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.
Pending Held and awaiting a human decision. The state the park step writes.
Approved An operator released the transaction to continue processing.
Declined An operator rejected the transaction.
ExpiredApproved The hold deadline elapsed with no reviewer decision and the merchant's configured expiry action released the transaction to continue processing. Only the parked flow itself can produce this: approving on expiry means going on to authorize the payment.
ExpiredDeclined The hold deadline elapsed with no reviewer decision and the transaction was rejected. Either the merchant configured a decline on expiry, or the backstop sweep reclaimed a hold whose flow did not survive to honor an approval. DispositionReasonCode tells the two apart.
dispositionAtUtc required string (date-time) UTC instant `disposition` last moved off `Pending`. `null` while the hold is still awaiting a decision. 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.
dispositionByUserId required string (uuid) The operator who dispositioned the hold. `null` when the expiry sweep decided it, which is exactly what distinguishes a human decision from an automatic one in the audit trail. 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.
dispositionReasonCode required string Why the hold was dispositioned the way it was: a stable gateway-authored code, or short operator-entered text. 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 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.