GetConsentConfigInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input for `GetAsync`. Optional usage scope filters which consent bullets render in Section 2 of the template.
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
usage
required |
StoredCredentialUsage StoredCredentialUsage | Filter for which `StoredCredentialUsage` scopes to render bullets for. When
null or `None`, all permitted scopes render; the
caller is expected to be rendering a generic consent page. 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.
| ||||||||||
merchantName
required |
string | Merchant name to substitute into `{{MerchantName}}`. Optional. When unset, the
service falls back to the authenticated merchant's display name.
Conditional: When MerchantName is not null. Max length: 200.
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.
| ||||||||||
kind
required |
ConsentPaymentKind ConsentPaymentKind | Which payment instrument the consent applies to. Selects the card vs ACH sibling
template and the matching tokenization-protection wording. Defaults to
`Card`.
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.
| ||||||||||
convenienceFeeDisclosure
required |
string | Free-text description of a convenience fee the cardholder will be charged on every charge under
this authorization (e.g. "$2.50 per payment"). Substituted into Section 3 of the rendered text;
when null or blank, the fee line does not render at all.
Conditional: When ConvenienceFeeDisclosure is not null. Max length: 500.
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.
| ||||||||||
cardPriceDisclosure
required |
string | Free-text statement of the card price charged to a card on every charge under this
authorization, for a merchant that posts a cash price and a card price (e.g. "$104.00 per
payment, against a cash price of $100.00"). Substituted into Section 3 of the rendered text;
when null or blank, the card price line does not render at all. Card consents only.
Conditional: When CardPriceDisclosure is not null. Max length: 500.
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 | Statement of the surcharge ceiling a recurring or installment charge to a card may carry (e.g.
"up to 3 percent of each payment, added to the amount above when a credit card is charged").
Substituted into Section 3 of the rendered text; when null or blank, the surcharge line does not
render at all. Card consents only.
Conditional: When SurchargeDisclosure is not null. Max length: 500.
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.