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

ProcessorRoutingRuleSetDto

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

A merchant's conditional processor routing configuration: an ordered, first-match list of rules that send a transaction to one of the merchant's own processor profiles.

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
enabled required boolean Whether this merchant's rule set is active. Defaults to `false`.
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.
attestation required ProcessorRoutingAttestationDto ProcessorRoutingAttestationDto The confirmation that every processor profile these rules target belongs to the same legal entity as the merchant. Required: When Enabled is true. Conditional: When Attestation is not null.
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 ProcessorRoutingAttestationDto:

Field Type Description
attestedBy required string (uuid) The id of the user who attested. Server-populated; any value supplied on input is ignored. 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.
attestedAtUtc required string (date-time) When the attestation was recorded, in UTC. Server-populated; any value supplied on input is ignored. 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.
note required string Optional free-text note, for example the entity or ownership evidence the attesting user relied on. nullablemax length 1024
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.

rules required array of ProcessorRoutingRuleDto array of ProcessorRoutingRuleDto The rules, in evaluation order. The first active rule whose conditions all match wins. Conditional: When Rules is not null. 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.

Fields of each ProcessorRoutingRuleDto:

Field Type Description
name required string Operator-facing label for this rule. Carries no matching semantics. nullablemax length 128
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.
isActive required boolean Whether this rule participates in evaluation. An inactive rule is skipped entirely.
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.
cardBrands required array of string array of Card brands this rule matches, as canonical lowercase tokens ("visa", "mastercard", "amex", "discover", "jcb", "diners", "unionpay", "interac"). Omit or send an empty list to match every brand. Recognized spellings are normalized on save, so "Visa" is stored as "visa"; an unrecognized brand is rejected. Conditional: When CardBrands is not null. 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.
tenderTypes required array of CardTenderType array of CardTenderType Card-rail tenders this rule matches. Omit or send an empty list to match every tender. Conditional: When TenderTypes is not null. 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.
CreditDebit Standard credit/debit card. The current card-rail behaviour. isDebitRouting modulates whether the request prefers debit-network routing within this rail.
EbtSnap EBT SNAP (food benefits). Routes through the EBT SNAP processor lane and requires PIN + card-present per program rules.
EbtCash EBT Cash (cash benefits). Distinct rail from SNAP; supports cashback where SNAP does not. PIN + card-present required.
Ewic eWIC (Women, Infants, and Children). Distinct rail from EBT, with item-level eligibility / voucher-select flow handled in the eWIC follow-up epic.
amountMin required number (double) Inclusive lower bound on the transaction amount. Omit for no lower bound. Conditional: When AmountMin is not null and AmountMax is not null. nullablemin 0
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.
amountMax required number (double) Inclusive upper bound on the transaction amount. Omit for no upper bound. nullablemin 0
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.
channels required array of TransactionSource array of TransactionSource Origination channels this rule matches. Accepts only VirtualTerminal, HostedPaymentPage, Api, and RecurringBilling. Omit or send an empty list to match every channel. Conditional: When Channels is not null. 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.
Unknown The source of the transaction is unknown or not specified.
VirtualTerminal The transaction originated from a virtual terminal interface.
Api The transaction was initiated through an API call.
HostedPaymentPage The transaction was processed via a hosted payment page.
RecurringBilling The transaction is part of a recurring billing cycle.
OfflineBatch The transaction was processed as part of an offline batch.
Invoicing The transaction is an automatic charge against an invoice (e.g. a recurring-invoice auto-charge or a smart-retry attempt) submitted by the Invoicing module.
targetProcessorProfileId required string (uuid) The processor profile a matching transaction is routed to. Must be one of the merchant's own profiles, and that profile must be active.
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.
fallthroughOnUnavailable required boolean What happens when this rule matches but its target profile cannot be used. The default, `false`, is strict: decline rather than route somewhere the operator did not choose. `true` falls through to the merchant's ordinary processor selection.
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.