# GET /api/merchants/{id}/processor-capabilities Processor Capability: lists what each of the merchant's active processor profiles can do. 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. **Operation ID:** `merchantProcessorCapabilityGet` ## Authorization No permission required. Requires API key scope: `admin` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | The merchant id. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`MerchantProcessorCapabilitiesDto`](https://devportal.demo.winkpg.io/docs/api/models/MerchantProcessorCapabilitiesDto.md) Properties: - `merchantId` (string(uuid)): The merchant the capabilities were resolved for. - `profiles` (array<[ProcessorProfileCapabilitiesDto](https://devportal.demo.winkpg.io/docs/api/models/ProcessorProfileCapabilitiesDto.md)>): 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) Fields of each item: - `processorProfileId` (string(uuid)): The processor profile these capabilities describe. Correlates with `processorProfileId` on the processor-profiles API. - `processorId` (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) - `processorName` (string): The processor's display name as stored on the profile. Presentation only: never match on this, always match on `processorId`. (nullable) - `supportsZeroDollarVerification` (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. - `supportsReversal` (boolean): Whether the processor accepts a reversal of an authorization that has not settled. - `reversalWindowSeconds` (integer(int32)): The maximum age, in seconds, an authorization may have and still be reversible, or `null` when the processor publishes no window. (nullable) - `supportsVoid` (boolean): Whether the processor accepts a void of a transaction in the open batch. - `supportsPartialRefund` (boolean): Whether the processor accepts a refund for less than the original settled amount. - `supportsPartialReversal` (boolean): Whether the processor accepts a reversal that releases only part of the authorization hold. When `false`, only full-amount reversals are accepted. - `supportedAdjustmentTypes` ([AdjustmentTypes](https://devportal.demo.winkpg.io/docs/api/models/AdjustmentTypes.md)): 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: - `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` (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) ### 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/merchants/{id}/processor-capabilities" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/{id}/processor-capabilities' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript 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) ```typescript const response = await fetch('{{BASE_URL}}/api/merchants/{id}/processor-capabilities', { 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 MerchantsApi(config); var result = await api.MerchantProcessorCapabilityGetAsync(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/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(); ``` ### 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.MerchantsApi(client) result = api.merchant_processor_capability_get("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/merchants/{id}/processor-capabilities", 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.