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

ProcessorProfileDto

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

Represents a payment processor profile assigned to a merchant, defining which processor handles transactions and which payment types are supported.

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) Gets or sets the unique identifier of this processor 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.
merchantId required string (uuid) Corresponding merchant 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.
paymentTypes required array of ProcessorProfilePaymentType array of ProcessorProfilePaymentType Payment types turned on for this profile. 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 ProcessorProfilePaymentType:

Field Type Description
id required string (uuid)
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 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.

isActive required boolean Shows if the current profile is active or not.
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.
enabledTenders required TenderEnableFlags TenderEnableFlags Per-tender enable flags applied by the capability cascade at the processor-account layer. `null` indicates "all disabled" for legacy profiles that have never opted in to a non-credit tender.
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 TenderEnableFlags:

Field Type Description
ebtSnap required boolean Whether `EbtSnap` is enabled at this layer.
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.
ebtCash required boolean Whether `EbtCash` is enabled at this layer.
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.
ewic required boolean Whether `Ewic` is enabled at this layer.
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.

merchantProcessorConfiguration required MerchantProcessorConfigurationDto MerchantProcessorConfigurationDto Corresponding configuration holding the details of the processor.
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 MerchantProcessorConfigurationDto:

Field Type Description
processorId required string Identifier of the processor. Use a value returned by the processor discovery endpoint (`GET /api/processors`), e.g. "tsys". 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 Name of the processor. Optional on input; informational. 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.
processorFieldValues required array of ProcessorFieldValueDto array of ProcessorFieldValueDto Values for the processor's configuration fields, keyed by the field definition's `Key`. Discover the expected keys via the processor config-schema endpoint. 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.

merchantConcurrencyStamp required string The merchant's concurrency stamp after the write that returned this profile, or `null` on a read. 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.
datawireRegistration required ProcessorProfileDatawireRegistrationDto ProcessorProfileDatawireRegistrationDto What automatic Datawire registration did during the write that returned this profile. Absent when it did not run (any non-Fiserv profile, a Fiserv profile that already carries a Datawire ID, and every read).
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 ProcessorProfileDatawireRegistrationDto:

Field Type Description
outcome required string The outcome name: one of the `DatawireRegistrationOutcome` values (`Registered`, `AlreadyProvisioned`, `Failed`, `ConfigurationError`, `RegisteredNotPersisted`), or `FaultedOutcome`. 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.
message required string A message written for the operator reading it, never a raw processor payload. Says what to do next where there is something to do. 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.
datawireId required string The Datawire ID that was issued but could not be written onto the profile, and only that. 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.

webhookRegistrationToken required string The token in this profile's webhook registration URL, for a processor whose provider sends webhooks to a URL registered per merchant. Absent for every other 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.

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.