Processor Capability: lists what each of the merchant's active processor profiles can do.

GET /api/merchants/{id}/processor-capabilities deprecated

Requires: Merchants.Merchants, merchant scope.

Requires API key scope: admin (Administration)

Example: `GET /api/merchants/3fa85f64-5717-4562-b3fc-2c963f66afa6/processor-capabilities`. Correlate each entry with the matching profile from `GET /api/merchants/{id}/processor-profiles` using `processorProfileId`. Two profiles boarded on the same processor report identical flags: capability is a property of the processor, not of the individual profile. A profile whose processor has no capability information registered reports every flag as `false`. That is deliberate: an unknown capability is reported as unsupported rather than assumed, so a caller never reads support for something the processor cannot do. Requires the merchant read permission, and answers `404` for a merchant outside the caller's scope exactly as it does for one that does not exist.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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/merchants/{id}/processor-capabilities" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/{id}/processor-capabilities' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}/processor-capabilities', {
  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 MerchantsApi(config);
var result = await api.MerchantProcessorCapabilityGetAsync(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/merchants/{id}/processor-capabilities");
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.MerchantsApi(client)
    result = api.merchant_processor_capability_get("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/merchants/{id}/processor-capabilities",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

id required

path

string (uuid)

The merchant id.

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

Body: MerchantProcessorCapabilitiesDto MerchantProcessorCapabilitiesDto Each item has these fields.

Field Type Description

merchantId required

string (uuid)

The merchant the capabilities were resolved 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.

profiles required

array of ProcessorProfileCapabilitiesDto array of ProcessorProfileCapabilitiesDto

One entry per active processor profile, in the order the profiles are stored on the merchant. Empty when the merchant has no active processor profile, which reads the same as "nothing is supported yet": a merchant that is not boarded cannot process anything. 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 ProcessorProfileCapabilitiesDto:

Field Type Description

processorProfileId required

string (uuid)

The processor profile these capabilities describe. Correlates with `processorProfileId` on the processor-profiles API.

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.

processorId required

string

The stable processor key the profile is boarded on (for example `tsys` or `fiserv`). Echoed exactly as stored on the profile, so it matches the value on the processor-profiles API. Compare it case-insensitively: the platform resolves the key that way and the stored casing is not normalized. 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.

processorName required

string

The processor's display name as stored on the profile. Presentation only: never match on this, always match on `processorId`. 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.

supportsZeroDollarVerification required

boolean

Whether this processor supports a zero-dollar account-verification authorization (authorize $0 with an AVS/CVV check, then void immediately). This is what gates the hosted payment page's "save my card, do not charge me" flow: when `false`, a save-card-only session on this processor cannot complete without an amount.

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.

supportsReversal required

boolean

Whether the processor accepts a reversal of an authorization that has not settled.

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.

reversalWindowSeconds required

integer (int32)

The maximum age, in seconds, an authorization may have and still be reversible, or `null` when the processor publishes no window. 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.

supportsVoid required

boolean

Whether the processor accepts a void of a transaction in the open batch.

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.

supportsPartialRefund required

boolean

Whether the processor accepts a refund for less than the original settled amount.

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.

supportsPartialReversal required

boolean

Whether the processor accepts a reversal that releases only part of the authorization hold. When `false`, only full-amount reversals are accepted.

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.

supportedAdjustmentTypes required

AdjustmentTypes AdjustmentTypes

The adjustment-shaped follow-up operations the processor advertises (offline adjustment, incremental authorization, both, or none). 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.

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`	Processor advertises no adjustment support. Both OfflineAdjustment and IncrementalAuthorization requests are rejected.
`OfflineAdjustment`	Processor accepts TransactionOperationType.OfflineAdjustment: pre-settlement edits to the stored settlement record (tip, tax, level-3, AVS) with no network call. Modeled by OfflineAdjustmentFlowRunner.
`IncrementalAuthorization`	Processor accepts TransactionOperationType.IncrementalAuthorization: an online amount-bumping auth on top of the existing approved hold (Visa Estimated/Incremental, MasterCard PreAuth+Final, Discover Incremental). Modeled by IncrementalAuthorizationFlowRunner.

softDescriptorNameMaxLength required

integer (int32)

The number of leading characters of the soft descriptor merchant name (the alternate merchant name sent on a transaction) that the processor prints on the cardholder statement. A longer name is accepted on the request and truncated by the processor. `null` when the processor declares no limit. 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.

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 Merchants

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Processor Capability: lists what each of the merchant's active processor profiles can do.

Example request

Parameters

Request body

Responses

Errors

Authentication