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.
|
customerId
required |
string (uuid)
|
The customer who gave the consent.
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.
|
paymentMethodId
required |
string (uuid)
|
The customer's stored payment method the consent covers. This is the stored payment method's id,
not a payment token.
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.
|
allowedUsages
required |
StoredCredentialUsage
StoredCredentialUsage |
The kinds of later charge the cardholder agreed to (a combination of flags). 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.
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.
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. |
|
consentTextVersion
required |
string
|
The version of the consent text the cardholder was shown: a hash of the rendered text, as returned
by the consent configuration operation and sent with the capture.
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.
|
consentText
required |
string
|
The exact consent text the cardholder was shown. Null when it was not recorded: a consent captured
before the text was kept, or one whose text was no longer held when it was captured. The
`consentTextVersion` is recorded either way.
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.
|
capturedAt
required |
string (date-time)
|
UTC time the cardholder gave consent.
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.
|
capturedVia
required |
ConsentCaptureChannel
ConsentCaptureChannel |
Where the consent was captured: the hosted payment page, the Virtual Terminal, the API, an import or
the merchant's back office.
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.
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. |
|
declaredMethod
required |
string
|
How the consent was obtained, for example `OnlineForm` or `Phone`: the method sent with an
API capture, or the method an operator recorded in the Virtual Terminal or the back office. Null for
a hosted payment page consent, whose evidence is the checkbox the cardholder ticked.
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.
|
enrollmentTerms
required |
EnrollmentTermsDto
EnrollmentTermsDto |
The terms the cardholder agreed to for a recurring or installment consent: the amount, frequency,
duration and any fee, card price or surcharge ceiling stated. Null when none were recorded.
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.
|
initialTransactionId
required |
string (uuid)
|
The transaction during which the consent was captured. Null for a consent captured without one,
such as a card stored with no payment.
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.
|
initialSchemeTransactionId
required |
string
|
The card network's transaction identifier from the initial cardholder-initiated transaction, which
later merchant-initiated charges reference. Null when the processor returned none.
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.
|
revokedAt
required |
string (date-time)
|
UTC time the consent was revoked. Null while it is active.
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.
|
isRevoked
required |
boolean
|
True when the consent has been revoked and no longer permits a merchant-initiated charge.
read only
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.
|
evidence
required |
ConsentRecordEvidenceDto
ConsentRecordEvidenceDto |
Evidence recorded by the hosted payment page when the cardholder consented there. Null for a consent
captured on another channel.
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.
|