Surcharging: Records a filed card-brand notice and starts the waiting period.

POST /api/surcharging/configurations/notices deprecated

Requires: Surcharging.Notice.File, merchant scope.

**Required permissions**: `Surcharging.Notice.File` **Scope**: merchant

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a FileNoticeDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/surcharging/configurations/notices" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/surcharging/configurations/notices' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, SurchargingApi } from '@winkpg/winkpg-api';

const api = new SurchargingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.surchargeConfigurationFileNotice({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/surcharging/configurations/notices', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new SurchargingApi(config);
var body = JsonSerializer.Deserialize<FileNoticeDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.SurchargeConfigurationFileNoticeAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/surcharging/configurations/notices");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.SurchargingApi(client)
    body = winkpg_api.FileNoticeDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.surcharge_configuration_file_notice(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/surcharging/configurations/notices",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)	The merchant the notice is filed for.
`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
`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
`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
`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

This request body has no documented fields.