Update custom field definitions for the signed-in user's merchant

PUT /api/merchants/self/custom-fields deprecated

Requires: Merchants.SelfServiceSettings.Manage, merchant scope.

Requires API key scope: admin (Administration)

Resolves the merchant from the signed-in user's context, which is established at interactive sign-in. A credential that carries no merchant context, such as an API key, receives `400 Merchants:NoCurrentMerchant` even when it holds the required scope and permission. API-key callers write the same values through `PUT /api/merchants/{id}` with `customFields` set, which requires the `Merchants.Merchants.Update` permission. The built-in Merchant role does not hold it, so a key owned by a merchant account has no API path to this setting; a reseller-owned or administrator-owned key does.

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 CustomFieldsSettingsDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/self/custom-fields" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customFields": [
    {
      "name": ""
    }
  ],
  "concurrencyStamp": "",
  "isFeatureEnabled": false
}'

PowerShell

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

$body = @'
{
  "customFields": [
    {
      "name": ""
    }
  ],
  "concurrencyStamp": "",
  "isFeatureEnabled": false
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/self/custom-fields' `
    -Headers $headers -ContentType 'application/json' -Body $body

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.merchantsUpdateCustomFields({
  "customFields": [
    {
      "name": ""
    }
  ],
  "concurrencyStamp": "",
  "isFeatureEnabled": false
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/self/custom-fields', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customFields": [
      {
        "name": ""
      }
    ],
    "concurrencyStamp": "",
    "isFeatureEnabled": false
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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 MerchantsApi(config);
var body = JsonSerializer.Deserialize<CustomFieldsSettingsDto>("""
    {
      "customFields": [
        {
          "name": ""
        }
      ],
      "concurrencyStamp": "",
      "isFeatureEnabled": false
    }
    """);

var result = await api.MerchantsUpdateCustomFieldsAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/merchants/self/custom-fields");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "customFields": [
        {
          "name": ""
        }
      ],
      "concurrencyStamp": "",
      "isFeatureEnabled": false
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.CustomFieldsSettingsDto.from_dict({
      "customFields": [
        {
          "name": ""
        }
      ],
      "concurrencyStamp": "",
      "isFeatureEnabled": False
    })
    result = api.merchants_update_custom_fields(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "customFields": [
    {
      "name": ""
    }
  ],
  "concurrencyStamp": "",
  "isFeatureEnabled": False
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/self/custom-fields",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

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

customFields required

array of CustomField array of CustomField

The merchant's custom field definitions. 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 CustomField:

Field Type Description

id required

string (uuid)

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.

name required

string

nullablemin length 3max length 50pattern ^[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*$

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.

notes required

array of EntityNote array of EntityNote

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.

tags required

array of EntityTag array of EntityTag

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.

isNumeric required

boolean

Conditional: When IsMultiValue is true.

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.

decimalPlaces required

integer (int32)

Conditional: When IsNumeric is true. Range: 0 to 2.

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.

maxLength required

integer (int32)

Conditional: When IsNumeric is false. Range: 0 to 300.

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.

regEx required

string

Conditional: When RegEx is not empty. 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.

regExErrorMessage required

string

Conditional: When RegExErrorMessage is not empty. Max length: 100. nullablemax length 100

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.

isRequired required

boolean

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.

isEnabled required

boolean

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.

description required

string

Conditional: When Description is not empty. Max length: 100. 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.

numericMinValue required

number (double)

For numeric fields, the minimum value allowed. Negative minimums are permitted: a custom field is merchant-defined metadata rather than a monetary amount, so ranges that span or sit below zero (adjustments, offsets, deltas, temperatures) are legitimate. The value is inert unless `isNumeric` is set, and is validated only in that case. Conditional: When IsNumeric is true. Range: -1000000000 to 1000000000.

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.

numericMaxValue required

number (double)

For numeric fields, the maximum value allowed. It must be greater than or equal to `numericMinValue` but is not required to be positive, since a field whose whole range is negative is valid. The value is inert unless `isNumeric` is set, and is validated only in that case. Conditional: When IsNumeric is true. Range: -1000000000 to 1000000000.

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.

position required

integer (int32)

min 0

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.

virtualTerminal required

CustomFieldPresence CustomFieldPresence

Presence settings for the Virtual Terminal, which collects this field from the operator when `visible` is set.

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.

hostedPaymentPage required

CustomFieldPresence CustomFieldPresence

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.

transactionReports required

CustomFieldTransactionReportsPresence CustomFieldTransactionReportsPresence

Presence settings for the surfaces that list a transaction's captured custom fields: the transaction detail page and the receipt. Only `visible` is honoured.

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.

showOnSaveCardSessions required

boolean

Whether this field is offered on a save-card hosted payment page session (one that stores the card without charging it). Defaults to off: most custom fields carry charge metadata (invoice number, purchase order, department) that is meaningless on a page whose only outcome is a stored card, so a field is suppressed on those sessions unless the merchant opts it in. 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.

legacyNumber required

integer (int64)

The integer key the v1 API addresses this definition by. Server-owned: allocated once, when the definition is first saved, and never reassigned afterwards. 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.

isMultiValue required

boolean

Whether a transaction carries a list of values for this field rather than a single value. A multi-value field is submitted through `TrxCustomField.Values`, prefilled on a hosted page session through `prefilledListFields`, and captured one value per line on the Virtual Terminal. The single `value` member keeps working on a multi-value definition: it is carried unchanged and mirrored into the list as its one item. 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.

maxValues required

integer (int32)

For a multi-value field, the largest number of values a transaction may carry. Unset reads as `DefaultMaxValues`; the platform ceiling is `MaxValuesCeiling`. Inert unless `isMultiValue` is set, and validated only in that case. Conditional: When IsMultiValue is true and MaxValues is not null. Range: 1 to 250. 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.

concurrencyStamp required

string

Concurrency stamp for optimistic concurrency control. 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.

isFeatureEnabled required

boolean

Whether the `AllowCustomFieldConfig` feature is enabled for this merchant. Read-only: set by the server, ignored on update.

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 request body has no documented fields.

Responses

200 OK

Body: CustomFieldsSettingsDto CustomFieldsSettingsDto Each item has these fields.

Field Type Description

customFields required

array of CustomField array of CustomField

The merchant's custom field definitions. 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 CustomField:

Field Type Description

id required

string (uuid)

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.

name required

string

nullablemin length 3max length 50pattern ^[A-Za-z0-9]+(?:_[A-Za-z0-9]+)*$

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.

notes required

array of EntityNote array of EntityNote

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.

tags required

array of EntityTag array of EntityTag

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.

isNumeric required

boolean

Conditional: When IsMultiValue is true.

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.

decimalPlaces required

integer (int32)

Conditional: When IsNumeric is true. Range: 0 to 2.

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.

maxLength required

integer (int32)

Conditional: When IsNumeric is false. Range: 0 to 300.

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.

regEx required

string

Conditional: When RegEx is not empty. 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.

regExErrorMessage required

string

Conditional: When RegExErrorMessage is not empty. Max length: 100. nullablemax length 100

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.

isRequired required

boolean

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.

isEnabled required

boolean

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.

description required

string

Conditional: When Description is not empty. Max length: 100. 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.

numericMinValue required

number (double)

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.

numericMaxValue required

number (double)

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.

position required

integer (int32)

min 0

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.

virtualTerminal required

CustomFieldPresence CustomFieldPresence

Presence settings for the Virtual Terminal, which collects this field from the operator when `visible` is set.

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.

hostedPaymentPage required

CustomFieldPresence CustomFieldPresence

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.

transactionReports required

CustomFieldTransactionReportsPresence CustomFieldTransactionReportsPresence

Presence settings for the surfaces that list a transaction's captured custom fields: the transaction detail page and the receipt. Only `visible` is honoured.

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.

showOnSaveCardSessions required

boolean

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.

legacyNumber required

integer (int64)

The integer key the v1 API addresses this definition by. Server-owned: allocated once, when the definition is first saved, and never reassigned afterwards. 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.

isMultiValue required

boolean

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.

maxValues required

integer (int32)

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.

concurrencyStamp required

string

Concurrency stamp for optimistic concurrency control. 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.

isFeatureEnabled required

boolean

Whether the `AllowCustomFieldConfig` feature is enabled for this merchant. Read-only: set by the server, ignored on update.

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.

403 Forbidden

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.

401 Unauthorized

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.

400 Bad Request

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.

404 Not Found

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.

409 Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.

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.

501 Not Implemented

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.

500 Internal Server Error

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.

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.

This response has no documented body fields.

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.

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

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

The API reference isn't available right now

No such operation

This reference may be out of date

Update custom field definitions for the signed-in user's merchant

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

409 Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.

501 Not Implemented

500 Internal Server Error

Errors

Authentication