RoutingResult
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The persisted routing decision on a transaction document. Contains the selected processor and the full evaluation audit trail.
Values
Fields
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
selectedProcessorKey
required |
string | The selected processor key.
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.
| ||||||||||||||||||
selectedProcessorProfileId
required |
string (uuid) | The selected processor profile ID.
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.
| ||||||||||||||||||
routingIndicator
required |
RoutingIndicator RoutingIndicator | Optional routing indicator applied to the transaction.
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.
| ||||||||||||||||||
matchedRuleName
required |
string | The name of the merchant processor routing rule that selected the processor profile, when a
rule did. `null` on every transaction a routing rule did not route.
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.
| ||||||||||||||||||
auditTrail
required |
array of RoutingRationale array of RoutingRationale | Full audit trail from the evaluation pipeline.
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 RoutingRationale: This body has no documented fields. | ||||||||||||||||||||
candidateSummaries
required |
array of RoutingOptionSummary array of RoutingOptionSummary | All candidates evaluated with their final scores.
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 RoutingOptionSummary:
This body has no documented fields. | ||||||||||||||||||||
This model has no documented fields.