WinkPG Docs
View as Markdown

llms.txt

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-10-22 22:57 UTC.

API reference Models

ResellerBranding

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

Represents branding information for a reseller, including domain, product, contact, and icon details.

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
brandedDomainName required string Gets or sets the branded domain name for the reseller. 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.
productName required string Gets or sets the product name for the reseller's offering. 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.
emailFromName required string Gets or sets the display name used in emails sent from the reseller. 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.
emailFromAddress required string Gets or sets the email address used as the sender in emails from the reseller. 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.
logo required string Gets or sets the URL or path to the reseller's logo. 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.
displayAddress required Address Address Gets or sets the display address for the reseller. Conditional: Conditional (see validator source).
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 of Address:

Field Type Description
id required string (uuid) Gets the unique identifier for the address. 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.
address1 required string Gets or sets the first line of the address (e.g., street address). nullablemax length 100
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.
address2 required string Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). nullablemax length 100
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.
city required string Gets or sets the city of the address. nullablemax length 100
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.
state required string Gets or sets the state or region of the address. nullablemax length 100
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.
province required string Gets or sets the province of the address (if applicable). 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.
zip required string Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. 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.
postalCode required string Gets or sets the postal code of the address. nullablemax length 20
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.
country required string Gets or sets the country of the address. Defaults to "USA". nullablemax length 100
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.
isMailing required boolean Gets or sets a value indicating whether this address is a mailing address.
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.
isDefault required boolean Gets or sets a value indicating whether this address is the default address.
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 body has no documented fields.

sdkGlobalName required string Gets or sets the window-global name the branded embed SDK shim assigns to the brand-neutral core artifact (for example "MyBrandPaySDK"). Falls back to the platform default global name when unset. Conditional: When SdkGlobalName is not empty. Max length: 60. 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.
supportPhone required string Gets or sets the support phone number for the reseller. 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.
salesPhone required string Gets or sets the sales phone number for the reseller. 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.
supportEmail required string Gets or sets the support email address for the reseller. 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.
favIcons required BrandingFavIcons BrandingFavIcons Gets or sets the favicon and icon URLs for the reseller's branding.
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 of BrandingFavIcons:

Field Type Description
favicon16 required string Gets or sets the URL for the 16x16 favicon. 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.
favicon32 required string Gets or sets the URL for the 32x32 favicon. 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.
favicon48 required string Gets or sets the URL for the 48x48 favicon. 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.
appleTouchIcon required string Gets or sets the URL for the Apple touch icon. 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.
androidChrome192 required string Gets or sets the URL for the Android Chrome 192x192 icon. 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.
androidChrome512 required string Gets or sets the URL for the Android Chrome 512x512 icon. 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 body has no documented fields.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.