WinkPG Docs
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

FraudScreeningConfig

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

Transaction screening configuration. Screening runs once per transaction, before authorization, and each rule inside it is configured independently.

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
contributors required FraudContributors FraudContributors The screening rules evaluated for this merchant. Null or absent leaves every rule unconfigured.
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 FraudContributors:

Field Type Description
velocity required VelocityContributorConfig VelocityContributorConfig Velocity Handler: caps how many transactions, and how much value, a merchant may run in a window.
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.
duplicateTransaction required DuplicateTransactionContributorConfig DuplicateTransactionContributorConfig Duplicate Transaction Manager: flags a repeat of a transaction already seen inside the configured window.
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.
amountRange required AmountRangeContributorConfig AmountRangeContributorConfig Amount Range Handler: flags a transaction whose amount falls outside the configured floor and ceiling.
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.
ipWhitelist required IPWhitelistContributorConfig IPWhitelistContributorConfig Whitelisted IPs: flags a cardholder IP address that matches none of the allowed ranges.
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.
ipBlacklist required IPBlacklistContributorConfig IPBlacklistContributorConfig Blacklisted IPs: flags a cardholder IP address that matches one of the blocked ranges.
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.
ipCountryRestriction required IPCountryRestrictionContributorConfig IPCountryRestrictionContributorConfig Country Restrictions Manager: flags a transaction by the country resolved from the cardholder IP address.
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.
binCountryMismatch required BinCountryMismatchContributorConfig BinCountryMismatchContributorConfig BIN Country Mismatch: flags a transaction whose card issuer country, billing country and cardholder IP country disagree. Null or absent leaves the rule off.
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.
timeOfDayRestriction required TimeOfDayRestrictionContributorConfig TimeOfDayRestrictionContributorConfig Time of Day Restriction: flags a transaction created outside the merchant's allowed hours. Null or absent leaves the rule off.
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.

reviewHoldDeadlineMinutes required integer (int32) How long, in minutes, a transaction held by one of this merchant's screening rules waits for a reviewer before its deadline passes. Applies to every rule whose action is `HoldForReview`; a hold requested by an external screening provider follows that provider's own setting instead. Null applies the platform default of 4320 minutes (three days). Accepted range 15 to 43200 (30 days). nullablemin 15max 43200
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.
reviewHoldExpiryAction required ReviewHoldExpiryAction ReviewHoldExpiryAction What happens to a transaction held by one of this merchant's screening rules when nobody approves or declines it before the deadline. `Decline` declines it, as a reviewer rejection would. `ApproveAndContinue` releases it to authorization and records that the deadline, not a reviewer, approved it. Null applies `Decline`. 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.
Decline Decline the held transaction when the deadline passes, exactly as a reviewer rejection would. The default.
ApproveAndContinue Release the held transaction to authorization when the deadline passes, recording that it was approved by expiry rather than by a reviewer.
cardTestingBackstopOverride required CardTestingBackstopOverride CardTestingBackstopOverride Lowers the platform card-testing protection for this merchant. `Observe` keeps detection and alerting but never refuses or stops one of this merchant's transactions; `Off` turns the protection off for this merchant. Null follows the platform setting. The override can only lower the protection, never raise it. Changing it requires a dedicated administrator permission. 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.
Off Count nothing for this merchant: no window, no detection, no enforcement.
Observe Count and detect for this merchant, and alert on an attack, but never refuse or stop one of its transactions, even when the platform enforces.

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.