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

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

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
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.
ProcessedAsCredit Indicates that the transaction was processed as a credit transaction.
ProcessedAsDebit Indicates that the transaction was processed as a debit transaction.
ProcessedAsStarSignatureDebit Indicates that the transaction was processed as a Star Signature debit transaction.
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:

Field Type Description
contributorName required string Name of the contributor that produced this rationale. 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.
reason required string Human-readable description of the action taken. 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 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:

Field Type Description
processorKey required string The 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.
profileId required string (uuid) The 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.
score required integer (int32) Final score after all contributors ran.
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.
eliminated required boolean Whether this candidate was eliminated.
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.
eliminationCategory required string The typed discriminator for <i>why</i> this candidate was eliminated, as its enum member name. `null` when the candidate survived, and on any candidate persisted before this field existed. 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 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.