Surcharging: Returns a merchant's effective per-state surcharge posture.

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 . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/surcharging/configurations/{merchantId}/state-policies/effective" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/surcharging/configurations/{merchantId}/state-policies/effective' `
    -Headers $headers

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.surchargeConfigurationGetEffectiveStatePolicies("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/surcharging/configurations/{merchantId}/state-policies/effective', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new SurchargingApi(config);
var result = await api.SurchargeConfigurationGetEffectiveStatePoliciesAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/surcharging/configurations/{merchantId}/state-policies/effective");
request.Headers.Add("api-key", "{{API_KEY}}");

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)
    result = api.surcharge_configuration_get_effective_state_policies("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/surcharging/configurations/{merchantId}/state-policies/effective",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

merchantId required

path

string (uuid)

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.

suppressNulls required

query

boolean

If true, omit properties with null 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.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

OK

Body: SurchargeEffectiveStatePoliciesDto SurchargeEffectiveStatePoliciesDto Each item has these fields.

Field Type Description

platformRulesEnforced required

boolean

Whether the platform-seeded ruleset is currently enforced underneath merchant policies. When `false`, every row's merged outcome comes from the merchant layer alone and the platform columns are informational.

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.

resolvedAtUtc required

string (date-time)

The instant the platform rules were resolved against, so a row's effective-dated rule is reproducible. UTC, as everything the API returns is.

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.

configurationExists required

boolean

Whether the merchant has a persisted surcharge configuration. When `false` there is nothing for a state policy to attach to, so the write path would fail; the view still resolves and shows the platform layer.

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.

policies required

array of SurchargeEffectiveStatePolicyDto array of SurchargeEffectiveStatePolicyDto

One row per constrained state, ordered by state code. States neither layer restricts are omitted. 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.

Fields of each SurchargeEffectiveStatePolicyDto:

Field Type Description

stateCode required

string

Two-letter US state or territory code, uppercase. 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.

hasMerchantOverride required

boolean

Whether the merchant has an entry of their own for this state. Reported separately from `merchantRestrictionType` because a null restriction cannot distinguish "no entry" from "an entry that never recorded one".

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.

merchantRestrictionType required

SurchargeStateRestrictionType SurchargeStateRestrictionType

The merchant's configured restriction for this state, or `null` when the merchant has no entry for it (in which case the platform layer alone governs). Check `hasMerchantOverride` to tell that apart from an entry with no restriction recorded. 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.

`Prohibited`	Surcharging is prohibited outright in the state.
`Restricted`	Surcharging is allowed but constrained (e.g. a state cap or disclosure rules).
`Permissive`	Surcharging is permitted with no state-specific restriction beyond network rules.

merchantCapRate required

number (double)

The merchant's configured cap for this state (decimal fraction), if any. 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.

platformRestrictionType required

SurchargeStateRestrictionType SurchargeStateRestrictionType

The platform-seeded restriction governing this state on the evaluation date, or `null` when the platform seeds no rule for it. 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.

`Prohibited`	Surcharging is prohibited outright in the state.
`Restricted`	Surcharging is allowed but constrained (e.g. a state cap or disclosure rules).
`Permissive`	Surcharging is permitted with no state-specific restriction beyond network rules.

platformCapRate required

number (double)

The platform-seeded cap for this state (decimal fraction), if any. 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.

platformCitation required

string

The statute the platform rule cites, for display beside the row. Rationale text only; nothing branches on it. 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.

effectiveIsProhibited required

boolean

Whether surcharging is prohibited in this state by the merged outcome. Reflects the enforcement gate: with platform rules unenforced, only the merchant layer can produce a prohibition.

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.

prohibitionSource required

SurchargeStateRuleSource SurchargeStateRuleSource

Which layer produced `effectiveIsProhibited`.

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.

`None`	Neither layer produced an outcome (no rule for the state).
`MerchantConfiguration`	The merchant's own SurchargeStatePolicy entry produced the outcome. Merchant policy can only tighten a platform rule, never relax one.
`PlatformPolicy`	The platform's seeded reference data (SurchargePlatformStatePolicyLookup) produced the outcome.

effectiveCapRate required

number (double)

The merged cap (decimal fraction), or `null` when neither layer imposes 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.

capSource required

SurchargeStateRuleSource SurchargeStateRuleSource

Which layer produced `effectiveCapRate`.

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.

`None`	Neither layer produced an outcome (no rule for the state).
`MerchantConfiguration`	The merchant's own SurchargeStatePolicy entry produced the outcome. Merchant policy can only tighten a platform rule, never relax one.
`PlatformPolicy`	The platform's seeded reference data (SurchargePlatformStatePolicyLookup) produced the outcome.

merchantEntryIsIneffective required

boolean

Whether the merchant's entry for this state is inert: it exists, but the merged outcome is identical to what the platform layer produces alone, so removing it would change nothing. The usual cause is an entry trying to relax a platform prohibition, which the merge ignores by design. Computed server-side so the UI does not have to re-derive the merge to detect it.

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 response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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 response has no documented body fields.

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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 RemoteServiceErrorInfo:

Field Type Description

code required

string

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.

message required

string

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.

details required

string

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.

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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 response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Surcharging

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Surcharging: Returns a merchant's effective per-state surcharge posture.

Example request

Parameters

Request body

Responses

Errors

Authentication