# ConsentConfigDto

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

The effective consent configuration for an authenticated merchant, returned by
`GetAsync`. API clients fetch this to render the exact
consent text the cardholder will see and to know whether capture is enforced.

## Fields
- `isConsentRequired` (boolean): True when the authenticated merchant's scope has consent capture enforced. A transaction that tokenizes/persists a card without a `StoredCredentialConsentInput` will be rejected with `stored_credential_consent_required`.
- `allowedUsages` ([StoredCredentialUsage](https://devportal.signapay-sbx.winkpg.io/docs/api/models/StoredCredentialUsage.md)): The usage scopes the merchant's configuration permits. Matches the flags that can legitimately appear on captured consents for this merchant; consumers render only the matching checkboxes / bullets. 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:
  - `None`: No permitted uses. Consent record is effectively inactive.
  - `Recurring`: Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring.
  - `Installment`: Fixed-schedule installment plans dividing a known total. Maps to Installment.
  - `UnscheduledCOF`: Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth.
  - `OneTimeFuture`: A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs.
- `text` ([ConsentTextConfigDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentTextConfigDto.md)): Rendered consent text with version metadata.
  Fields:
  - `version` (string): Version hash of the rendered template. Clients persist this and submit it back on the transaction so WinkPG records exactly what the cardholder saw. (nullable)
  - `rendered` (string): Fully-rendered, substituted consent text with merchant variables applied. No `{{Variable}}` markers should remain in well-configured merchants; any that do are surfaced via `missingVariables` for diagnosis. (nullable)
  - `locale` (string): Locale of the rendered text. Single-locale (en-US) for v1. (nullable)
  - `lastUpdatedAt` (string(date-time)): Reserved. Always `1970-01-01T00:00:00Z` today; `version` is the identity of the text.
  - `missingVariables` (array<string>): Reserved for the names of template variables that had no value at render time. Always empty today. (nullable)
- `disclosures` ([ConsentDisclosuresDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ConsentDisclosuresDto.md)): Merchant-configured disclosure URLs referenced from the consent text.
  Fields:
  - `termsUrl` (string): Merchant's terms of service URL. Empty when not configured. (nullable)
  - `privacyUrl` (string): Merchant's privacy policy URL. Empty when not configured. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.