ProcessorRoutingRuleDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One conditional routing rule: a set of match conditions and the processor profile a matching transaction is sent to.
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 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
| ||||||||||||||
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.
| ||||||||||||||
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 model has no documented fields.