WinkPG Docs
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:57 UTC.

API reference Models

MerchantBillingPaymentMethodCaptureReadinessDto

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

Whether the reseller-level plumbing required to capture a stored payment method for a merchant is configured. Returned when you read the capture readiness for a merchant. Use it as a pre-flight check: disable Card or ACH capture (per kind) and explain the gap up front, rather than letting the operator enter an instrument that the capture request then rejects.

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
resellerId required string (uuid) The merchant's parent reseller, so the page can deep-link to the reseller's billing preferences (`/reseller/{ResellerId}`) where the operator fixes any unmet prerequisite. The caller is already authorized for the merchant, so this is the caller's own reseller (no cross-reseller leak).
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.
collectionMerchantConfigured required boolean Whether the reseller has a `CollectionMerchantId` configured (required for any capture).
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.
captureHppConfigured required boolean Whether the reseller has a card-capture `CaptureHppPageId` configured (required for any capture).
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.
cardAllowed required boolean Whether the reseller's allowlist permits Card capture (`AllowCardPayments != false`).
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.
achAllowed required boolean Whether the reseller's allowlist permits ACH capture (`AllowAchPayments != false`).
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.
effectiveResellerId required string (uuid) The reseller whose collection configuration the flags above describe. Equal to `resellerId` when the merchant's reseller has its own configuration (or nothing is configured anywhere); the nearest configured ancestor when the configuration is inherited. Absent from responses produced before inheritance 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.
effectiveResellerName required string The display name of `effectiveResellerId`, when it resolved. 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.
isInherited required boolean Whether the configuration is inherited from an ancestor of the merchant's reseller rather than set on it. When `true`, an unmet prerequisite is fixed on `effectiveResellerId`, not on `resellerId`.
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.
effectiveResellerWithinScope required boolean Whether the calling operator may act on `effectiveResellerId`. Always `true` when the configuration is not inherited (the caller is already authorized for the merchant's reseller); for an inherited configuration it is `false` for an operator whose own reseller sits below the configured ancestor, who must ask the administrator or that ancestor to change it.
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.