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

ProcessorSummaryDto

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

Lightweight summary of a supported processor, returned by the processor discovery endpoint. Use the `processorId` to request that processor's full configuration schema.

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
processorId required string Stable identifier of the processor (e.g. "tsys"). Pass this to the config-schema endpoint and submit it as the processor configuration's `ProcessorId` on a merchant create/update. 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 Display name of the processor. 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.
supportedPaymentTypes required array of string array of Names of the payment types this processor supports (e.g. "Visa", "Mastercard", "EbtSnap"). These can be passed as the payment-types filter when requesting the config schema. 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.
paymentTypes required array of ProcessorPaymentTypeRefDto array of ProcessorPaymentTypeRefDto The payment types this processor supports, as explicit `{id, name}` pairs. Use this to populate a profile's payment types deterministically without scraping the GUIDs off a live merchant document. The ids are global constants (identical across environments); a client may also submit a payment type by `name` alone and let the server resolve the id. 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 ProcessorPaymentTypeRefDto:

Field Type Description
id required string (uuid) Global, environment-independent identifier of the payment type.
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.
name required string Name of the payment type (e.g. "Visa", "Debit", "EbtSnap"). This is the value a client submits when populating a profile's payment types; the server resolves `id` from it. 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.
displayName required string Human-readable label for `name` (e.g. "American Express" for `Amex`, "EBT SNAP" for `EbtSnap`). 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.
enabledByDefault required boolean Whether the processor recommends this payment type be enabled on a new profile.
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.

schemaVersion required string Opaque, deterministic content hash of this processor's full projected field schema: the same value returned (and emitted as an ETag) by the config-schema endpoint. Lets a client detect that a processor's schema changed from a single listing call, without re-fetching every schema. 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 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.