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

ProcessorProfileSummaryDto

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

Read-only, non-secret summary of a merchant processor profile for display in a viewer (e.g. the transaction-detail routing-decision panel's profile modal). Deliberately distinct from `ProcessorProfileDto`: it is produced by a non-decrypting read (`GetProcessorProfileSummaryAsync`) and never carries secret processor field values. Only field definitions marked non-secret are projected into `displayFields`; secret values are not read, not decrypted, and not present in this shape at all.

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
processorProfileId required string (uuid) The processor profile's unique identifier.
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.
processorKey required string The processor key (processor configuration id, e.g. "tsys", "cash"). Empty when the profile has no configuration. 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.
processorName required string Human-friendly processor name for display. Falls back to `processorKey` when the profile carries no explicit name. 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.
isActive required boolean Whether the profile is 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.
paymentTypes required array of string array of Payment-type names enabled on the profile (e.g. "Credit", "Debit", "ACH"). 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.
displayFields required array of ProcessorProfileSummaryFieldDto array of ProcessorProfileSummaryFieldDto Non-secret configuration fields safe to display, as label/value pairs. Only field definitions whose `IsSecret` flag is false are included; secret fields are excluded server-side before this DTO is built, so no secret value ever reaches the shape. 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 ProcessorProfileSummaryFieldDto:

Field Type Description
name required string Human-friendly field label. 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.
value required string The field's displayed value (non-secret). 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.
category required string The field definition's UI grouping category (for example "Credit", "Debit", "EBT"). Projected verbatim from the processor's field definition so a viewer can group fields whose labels are only unique within a category. Null, blank, or the processor-default category all mean the field belongs to the catch-all group. 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.
position required integer (int32) The field definition's relative position, used to order fields within their category. Lower sorts first; ties keep the order the values were projected in.
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.