WinkPG Docs

View as Markdown

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.

`SurchargeNoticeRecordDto`

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

Read-only data-transfer representation of a filed card-brand surcharge notice embedded in a merchant's configuration. Notices are per network, each with its own effective date.

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

noticeId required

string (uuid)

The notice's identifier, used to name it in an amendment. Null on a notice recorded before notice identifiers were assigned; such a notice cannot be amended and is corrected by filing a new one. 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.

network required

string

The card network the notice covers; null for an all-network notice. 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.

filedAt required

string (date-time)

When this record was created in WinkPG. 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.

attestedNoticeDate required

string (date-time)

The calendar date the merchant attested they filed notice with the card networks, when that predates `filedAt`. Null when the notice was filed as of the record date. 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.

effectiveAt required

string (date-time)

When the notice becomes effective (the network is surchargeable at/after this instant). 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.

filedByUserId required

string

The user who filed the notice. 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.

filedByApiKeyId required

string (uuid)

The API key the notice was filed under, or null when it was not filed over the API (a notice filed from the portal records neither this nor `filedByApiKeyName`, and so does every notice recorded before provenance was captured). 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.

filedByApiKeyName required

string

The display name the API key carried when the notice was filed. Never re-resolved, so a key renamed since keeps naming itself here the way it was named at the time. 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.

referenceNumber required

string

The notice reference number issued by the network / processor. The only field an amendment changes. 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.

amendedAt required

string (date-time)

When the reference number was last amended, or null when it never has been. 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.

amendedBy required

string (uuid)

The user who last amended the reference number, or null when it has never been amended or the amending caller carried no user id. 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.

processorAccountId required

string

The processor account the notice was filed under: a processor profile id from the merchant's processing settings, or null for a notice that covers every processor. A value recorded before filing checked it against the merchant's profiles reads back exactly as it was written. 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.

coversAllProcessors required

boolean

Whether the notice covers every card processor the merchant is boarded on, which is true when it names no processor account.

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.

coveredProcessorProfileIds required

array of string (uuid) array of

The card processor profiles the notice covers: the one it names, or every card processor profile on the merchant for a notice that names none. Empty when the stored processor account is not a profile id, or when the merchant's profiles could not be read for an all-processor notice. 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.