# GET /api/processors/{processorId}/config-schema/template

Returns a ready-to-fill processor profile skeleton for the given processor and payment-type
selection, suitable for dropping into `processing.processorProfiles[]` on a merchant
create/update.

**Required permissions**: `Transactions.ProcessorConfiguration.ViewSchema`  
**Scope**: merchant

**Operation ID:** `GET_api_processors_processorId_config-schema_template`

## Authorization

Requires: Transactions.ProcessorConfiguration.ViewSchema, merchant scope.

Required permissions:
- `Transactions.ProcessorConfiguration.ViewSchema`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| processorId | path | yes | string | The processor identifier (e.g. "tsys"). |
| paymentTypes | query | no | array<string> | Payment type names to scope the template to; omit for universally-applicable fields only. |
| includeOptional | query | no | boolean | When false (default), only required and defaulted fields are emitted; when true, all applicable  fields are emitted. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateMerchantsProcessorProfileDto`

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

Schema: `PhoeniXGateMerchantsProcessorProfileDto`

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

Schema: `PhoeniXGateMerchantsProcessorProfileDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

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