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

ProcessorProfileCapabilitiesDto

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

The capabilities one of a merchant's boarded processor profiles can actually deliver.

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 these capabilities describe. Correlates with `processorProfileId` on the processor-profiles API.
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.
processorId required string The stable processor key the profile is boarded on (for example `tsys` or `fiserv`). Echoed exactly as stored on the profile, so it matches the value on the processor-profiles API. Compare it case-insensitively: the platform resolves the key that way and the stored casing is not normalized. 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 The processor's display name as stored on the profile. Presentation only: never match on this, always match on `processorId`. 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.
supportsZeroDollarVerification required boolean Whether this processor supports a zero-dollar account-verification authorization (authorize $0 with an AVS/CVV check, then void immediately). This is what gates the hosted payment page's "save my card, do not charge me" flow: when `false`, a save-card-only session on this processor cannot complete without an amount.
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.
supportsReversal required boolean Whether the processor accepts a reversal of an authorization that has not settled.
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.
reversalWindowSeconds required integer (int32) The maximum age, in seconds, an authorization may have and still be reversible, or `null` when the processor publishes no window. 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.
supportsVoid required boolean Whether the processor accepts a void of a transaction in the open batch.
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.
supportsPartialRefund required boolean Whether the processor accepts a refund for less than the original settled amount.
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.
supportsPartialReversal required boolean Whether the processor accepts a reversal that releases only part of the authorization hold. When `false`, only full-amount reversals are accepted.
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.
supportedAdjustmentTypes required AdjustmentTypes AdjustmentTypes The adjustment-shaped follow-up operations the processor advertises (offline adjustment, incremental authorization, both, or none). 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.
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.
None Processor advertises no adjustment support. Both OfflineAdjustment and IncrementalAuthorization requests are rejected.
OfflineAdjustment Processor accepts TransactionOperationType.OfflineAdjustment: pre-settlement edits to the stored settlement record (tip, tax, level-3, AVS) with no network call. Modeled by OfflineAdjustmentFlowRunner.
IncrementalAuthorization Processor accepts TransactionOperationType.IncrementalAuthorization: an online amount-bumping auth on top of the existing approved hold (Visa Estimated/Incremental, MasterCard PreAuth+Final, Discover Incremental). Modeled by IncrementalAuthorizationFlowRunner.
softDescriptorNameMaxLength required integer (int32) The number of leading characters of the soft descriptor merchant name (the alternate merchant name sent on a transaction) that the processor prints on the cardholder statement. A longer name is accepted on the request and truncated by the processor. `null` when the processor declares no limit. 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.