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-26 23:26 UTC.

`FileNoticeDto`

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 recording a filed card-brand surcharge notice for a merchant. Filing a notice starts the mandatory waiting period; the configuration's `WaitingPeriodExpiresAt` is set to the date the merchant filed notice with the networks plus the configured waiting-period days.

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

merchantId required

string (uuid)

The merchant the notice is filed for.

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. When set, it must be one of these spellings: Visa; Mastercard, Master Card or MC; Discover; Amex or American Express; JCB; Diners, Diners Club or Diners Club International; UnionPay, Union Pay, China Union Pay, China UnionPay or CUP; Interac. Case and surrounding spaces are ignored, and the name is stored and returned as sent. Conditional: When Network is not null. Max length: 64. 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. Conditional: When ReferenceNumber is not null. Max length: 128. Required: When AttestedNoticeDate is not null. 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 card processor the notice is filed for: a processor profile id from the merchant's processing settings. Optional; leave it out to file a notice that covers every card processor the merchant is boarded on. A value that is not one of the merchant's card processor profiles, active or not, is refused with `Surcharging:ProcessorAccountNotFound`. The resolved profile id is stored in its canonical form. Conditional: When ProcessorAccountId is not null. Max length: 128. 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)

The calendar date the merchant filed notice with the card networks, when that predates this record. Supplying it runs the same waiting period from the real notice date instead of from now, so a merchant who filed before onboarding is not made to wait a second time. It is an attestation, not a bypass: the configured waiting period and its floor still apply in full. Conditional: When AttestedNoticeDate is not null. 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.