# POST /api/surcharging/quote

Surcharging: Quotes surcharge eligibility for a card BIN prefix and amount.

**Required permissions**: `Surcharging.Configuration.View`  
**Scope**: merchant

**Operation ID:** `surchargeQuoteGetQuote`

## Authorization

Requires: Surcharging.Configuration.View, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Surcharging.Configuration.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

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

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for.
- `binPrefix` (string) required: The card BIN prefix: 6 to 8 digits only. A full PAN (or any value longer than 8 digits) is  rejected at validation. Used to resolve the card brand, funding source, and issuer country. (nullable, pattern ^[0-9]{6,8}$)
- `amount` (number(double)): The base transaction amount a surcharge would apply to, in the transaction currency. (greater than 0)
- `cardholderState` (string): The cardholder billing state code (2-letter, e.g. CO), or null when unknown. Governs the  per-state cap / prohibition. Merchant-state rules are applied authoritatively at auth time. Conditional: When CardholderState is not empty. (nullable)
- `channel` ([TransactionSource](https://devportal.demo.winkpg.io/docs/api/models/TransactionSource.md)): The presentment channel the quote is for. Defaults to `Api`, the  natural channel for a direct integrator; surcharge eligibility is channel-restricted.
  Values:
  - `Unknown`: The source of the transaction is unknown or not specified.
  - `VirtualTerminal`: The transaction originated from a virtual terminal interface.
  - `Api`: The transaction was initiated through an API call.
  - `HostedPaymentPage`: The transaction was processed via a hosted payment page.
  - `RecurringBilling`: The transaction is part of a recurring billing cycle.
  - `OfflineBatch`: The transaction was processed as part of an offline batch.
  - `Invoicing`: The transaction is an automatic charge against an invoice (e.g. a recurring-invoice auto-charge or a smart-retry attempt) submitted by the Invoicing module.

**Content type:** `text/json`

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

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for.
- `binPrefix` (string) required: The card BIN prefix: 6 to 8 digits only. A full PAN (or any value longer than 8 digits) is  rejected at validation. Used to resolve the card brand, funding source, and issuer country. (nullable, pattern ^[0-9]{6,8}$)
- `amount` (number(double)): The base transaction amount a surcharge would apply to, in the transaction currency. (greater than 0)
- `cardholderState` (string): The cardholder billing state code (2-letter, e.g. CO), or null when unknown. Governs the  per-state cap / prohibition. Merchant-state rules are applied authoritatively at auth time. Conditional: When CardholderState is not empty. (nullable)
- `channel` ([TransactionSource](https://devportal.demo.winkpg.io/docs/api/models/TransactionSource.md)): The presentment channel the quote is for. Defaults to `Api`, the  natural channel for a direct integrator; surcharge eligibility is channel-restricted.
  Values:
  - `Unknown`: The source of the transaction is unknown or not specified.
  - `VirtualTerminal`: The transaction originated from a virtual terminal interface.
  - `Api`: The transaction was initiated through an API call.
  - `HostedPaymentPage`: The transaction was processed via a hosted payment page.
  - `RecurringBilling`: The transaction is part of a recurring billing cycle.
  - `OfflineBatch`: The transaction was processed as part of an offline batch.
  - `Invoicing`: The transaction is an automatic charge against an invoice (e.g. a recurring-invoice auto-charge or a smart-retry attempt) submitted by the Invoicing module.

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

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

Properties:
- `merchantId` (string(uuid)) required: The merchant the quote is for.
- `binPrefix` (string) required: The card BIN prefix: 6 to 8 digits only. A full PAN (or any value longer than 8 digits) is  rejected at validation. Used to resolve the card brand, funding source, and issuer country. (nullable, pattern ^[0-9]{6,8}$)
- `amount` (number(double)): The base transaction amount a surcharge would apply to, in the transaction currency. (greater than 0)
- `cardholderState` (string): The cardholder billing state code (2-letter, e.g. CO), or null when unknown. Governs the  per-state cap / prohibition. Merchant-state rules are applied authoritatively at auth time. Conditional: When CardholderState is not empty. (nullable)
- `channel` ([TransactionSource](https://devportal.demo.winkpg.io/docs/api/models/TransactionSource.md)): The presentment channel the quote is for. Defaults to `Api`, the  natural channel for a direct integrator; surcharge eligibility is channel-restricted.
  Values:
  - `Unknown`: The source of the transaction is unknown or not specified.
  - `VirtualTerminal`: The transaction originated from a virtual terminal interface.
  - `Api`: The transaction was initiated through an API call.
  - `HostedPaymentPage`: The transaction was processed via a hosted payment page.
  - `RecurringBilling`: The transaction is part of a recurring billing cycle.
  - `OfflineBatch`: The transaction was processed as part of an offline batch.
  - `Invoicing`: The transaction is an automatic charge against an invoice (e.g. a recurring-invoice auto-charge or a smart-retry attempt) submitted by the Invoicing module.

## Responses

### 200

OK

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

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

Properties:
- `eligible` (boolean): Whether the transaction may be surcharged.
- `surchargeRate` (number(double)): The applied surcharge rate as a decimal fraction (0.03 = 3%); null when ineligible. (nullable)
- `surchargeAmount` (number(double)): The computed surcharge amount, in the transaction currency; null when ineligible. (nullable)
- `baseAmount` (number(double)): The base transaction amount the quote was computed against, in the transaction currency.
- `totalWithSurcharge` (number(double)): The base amount plus the computed surcharge, in the transaction currency; equals  `baseAmount` when ineligible.
- `ineligibilityReason` (string): The ineligibility reason code (the `SurchargeIneligibilityReason` name, e.g.  DebitCard, NonUsIssuedCard), or null when eligible. (nullable)
- `requiresDisclosure` (boolean): Whether the caller must present a surcharge disclosure to the cardholder before payment.
- `disclosureText` (string): The ready-to-render disclosure text (rate stated plus the does-not-exceed-cost-of-acceptance  statement), matching what the Virtual Terminal and Hosted Payment Page show the same cardholder.  Non-null only when `eligible` is true. (nullable)

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

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

### cURL

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

### PowerShell

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

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

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

### 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.surchargeQuoteGetQuote({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "binPrefix": ""
});
```

### TypeScript (raw HTTP)

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

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;
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<SurchargeQuoteRequestDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "binPrefix": ""
    }
    """);

var result = await api.SurchargeQuoteGetQuoteAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

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

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

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)
    body = winkpg_api.SurchargeQuoteRequestDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "binPrefix": ""
    })
    result = api.surcharge_quote_get_quote(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

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

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/surcharging/quote",
    headers=headers,
    json=body,
)
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.