# GET /api/surcharging/configurations/{merchantId}/state-policies/effective

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

Each constrained state is reported with the platform-seeded rule, the merchant's own
override, and the merged outcome, plus whether the platform ruleset is currently enforced.
The merge is applied here so a caller never has to combine the two layers itself.

**Operation ID:** `surchargeConfigurationGetEffectiveStatePolicies`

## Authorization

Requires: Surcharging.Admin.GlobalSettings, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Surcharging.Admin.GlobalSettings`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| merchantId | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`SurchargeEffectiveStatePoliciesDto`](https://devportal.demo.winkpg.io/docs/api/models/SurchargeEffectiveStatePoliciesDto.md)

Properties:
- `platformRulesEnforced` (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.
- `resolvedAtUtc` (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.
- `configurationExists` (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.
- `policies` (array<[SurchargeEffectiveStatePolicyDto](https://devportal.demo.winkpg.io/docs/api/models/SurchargeEffectiveStatePolicyDto.md)>): One row per constrained state, ordered by state code. States neither layer restricts are omitted. (nullable)
  Fields of each item:
  - `stateCode` (string): Two-letter US state or territory code, uppercase. (nullable)
  - `hasMerchantOverride` (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".
  - `merchantRestrictionType` ([SurchargeStateRestrictionType](https://devportal.demo.winkpg.io/docs/api/models/SurchargeStateRestrictionType.md)): 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:
    - `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` (number(double)): The merchant's configured cap for this state (decimal fraction), if any. (nullable)
  - `platformRestrictionType` ([SurchargeStateRestrictionType](https://devportal.demo.winkpg.io/docs/api/models/SurchargeStateRestrictionType.md)): The platform-seeded restriction governing this state on the evaluation date, or `null` when  the platform seeds no rule for it. (nullable)
    Values:
    - `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` (number(double)): The platform-seeded cap for this state (decimal fraction), if any. (nullable)
  - `platformCitation` (string): The statute the platform rule cites, for display beside the row. Rationale text only; nothing  branches on it. (nullable)
  - `effectiveIsProhibited` (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.
  - `prohibitionSource` ([SurchargeStateRuleSource](https://devportal.demo.winkpg.io/docs/api/models/SurchargeStateRuleSource.md)): Which layer produced `effectiveIsProhibited`.
    Values:
    - `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` (number(double)): The merged cap (decimal fraction), or `null` when neither layer imposes one. (nullable)
  - `capSource` ([SurchargeStateRuleSource](https://devportal.demo.winkpg.io/docs/api/models/SurchargeStateRuleSource.md)): Which layer produced `effectiveCapRate`.
    Values:
    - `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` (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.

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

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.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## 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.

### cURL

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

### PowerShell

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

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

```typescript
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();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.