ConsentCaptureChannel
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The capture channel that produced a stored credential consent record. Determines which fields on `ConsentEvidence` are populated and how the consent is presented in the admin UI.
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.
HostedPaymentPage |
Captured during a hosted payment page checkout via an opt-in checkbox the cardholder ticked. Strongest evidence: cardholder's own action with IP, user agent, and session identifier recorded. |
VirtualTerminal |
Captured in the virtual terminal as a merchant operator attestation that consent was obtained from the cardholder offline (in person, by phone, signed form, etc.). Operator identity and capture method recorded. |
Api |
Declared by an integrating merchant via the API. The merchant takes liability for the declaration; WinkPG records the API key, timestamp, and merchant-supplied reference. |
Imported |
Imported from an external system (e.g. legacy migration, bulk reseller onboarding). Evidence captured outside WinkPG and recorded only as a reference to the external system. |
MerchantAdmin |
Captured when a merchant admin manually adds a stored payment method to a customer from the back-office (Customers > customer > Payment Methods). The operator attests that they obtained the cardholder's / account holder's authorization off-line (by phone, in person, or via a signed form on file) and records where the merchant retains that artifact. Operator identity, capture method, ACH authorization type (for bank-account credentials), and a merchant evidence reference are recorded on ConsentEvidence. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.