WinkPG Docs

View as Markdown

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-11-12 05:58 UTC.

`EnrollmentTermsDto`

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 mirror of the terms a cardholder agreed to at enrollment, as recorded on the consent. Surfaced in the admin evidence drawer so the disclosure the cardholder accepted stays readable from the consent itself. Every member is merchant-authored terms text, a plan amount, a rate, a UTC instant or a short reason code: none is a token, a card number or cardholder contact data.

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

amount required

string

Statement of the amount the cardholder agreed to (for example "$29.99 per month"). 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.

frequency required

string

Statement of the charge frequency. 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.

duration required

string

Statement of how long the authorization remains in effect. 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.

fixedAmount required

number (double)

Fixed per-payment amount the cardholder agreed to, when one was recorded. Carries no currency. 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.

amountRangeDescription required

string

Description of the agreed amount range for variable-amount charges. 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.

convenienceFee required

string

Statement of the convenience fee the cardholder agreed to pay on every charge. 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.

cardPrice required

string

Statement of the dual pricing card price the cardholder agreed to pay on every card charge. 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.

surchargeDisclosure required

string

The surcharge ceiling statement the consent text stated. 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.

surchargeMaxRate required

number (double)

The surcharge ceiling as a decimal fraction (`0.03` is 3 percent). 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.

surchargeNoticeSentAt required

string (date-time)

UTC instant the cardholder was emailed the surcharge notice after enrollment. 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.

surchargeEffectiveFrom required

string (date-time)

UTC instant from which a charge under this consent may carry the noticed surcharge. 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.

surchargeNoticeUndeliverableAt required

string (date-time)

UTC instant the notice sweep found no way to email the cardholder. 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.

surchargeNoticeUndeliverableReason required

string

Short reason code for why the notice could not be sent. Never an address. 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.