# PUT /api/merchants/self/order-data-defaults

Update order data defaults for the signed-in user's merchant

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 `processing.orderDataDefaults` 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.

**Operation ID:** `merchantsUpdateOrderDataDefaults`

## Authorization

Requires: Merchants.SelfServiceSettings.Manage, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Merchants.SelfServiceSettings.Manage`

## Parameters

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

## Request Body

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

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

Properties:
- `settings` ([OrderDataDefaultSettings](https://devportal.demo.winkpg.io/docs/api/models/OrderDataDefaultSettings.md)): The order data default settings values.
  Fields:
  - `enable` (boolean)
  - `applyLevel2DefaultsToApi` (boolean)
  - `applyLevel3DefaultsToApi` (boolean)
  - `applyLevel2DefaultsToVt` (boolean)
  - `applyLevel3DefaultsToVt` (boolean)
  - `applyLevel2DefaultsToHpp` (boolean): Whether Level 2 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every  merchant document written before this toggle existed already had: hosted page transactions were  bucketed under the API toggle. (nullable)
  - `applyLevel3DefaultsToHpp` (boolean): Whether Level 3 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel3DefaultsToApi`". See  `applyLevel2DefaultsToHpp` for why. (nullable)
  - `defaultMerchantZip` (string): Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultTaxRate` (number(double)): Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate.  Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). (nullable, min 0)
  - `defaultShipFromZip` (string): Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultDestinationCountryCode` (string): Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). (nullable, max length 3)
  - `defaultDutyAmount` (number(double)): Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. (nullable, min 0)
  - `defaultFreightAmount` (number(double)): Default freight/shipping amount for L3 enhanced data. (nullable, min 0)
  - `defaultDiscountAmount` (number(double)): Default header-level discount amount for L3 enhanced data. (nullable, min 0)
  - `defaultLineItemValues` ([LineItemDefaults](https://devportal.demo.winkpg.io/docs/api/models/LineItemDefaults.md)): Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
  - `defaultLineItem` ([Level3LineItem](https://devportal.demo.winkpg.io/docs/api/models/Level3LineItem.md)): A template line item that auto-populates as the first line item on new transactions.  Useful for single-product merchants (parking, subscriptions, recurring services).  When null, no template line item is added.
- `concurrencyStamp` (string): Concurrency stamp for optimistic concurrency control. (nullable)
- `isFeatureEnabled` (boolean): Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant.  Read-only: set by the server, ignored on update.
- `virtualTerminalFields` ([VirtualTerminalFields](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalFields.md)): The merchant's Virtual Terminal field configuration at the time of load.  Used by the UI to enforce cross-field constraints (e.g. a default tax rate  requires `taxAmount` to be enabled).  Read-only: set by the server, ignored on update.
  Fields:
  - `customer` ([VirtualTerminalCustomerField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalCustomerField.md))
  - `invoiceNumber` ([VirtualTerminalInvoiceNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalInvoiceNumField.md))
  - `purchaseOrderNumber` ([VirtualTerminalPurchaseOrderNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPurchaseOrderNumField.md))
  - `billingAddress` ([VirtualTerminalBillingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalBillingAddressFieldGroup.md))
  - `shippingAddress` ([VirtualTerminalShippingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAddressFieldGroup.md))
  - `contactPhone` ([VirtualTerminalPhoneField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPhoneField.md))
  - `level3Amount` ([VirtualTerminalLevel3AmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalLevel3AmountField.md))
  - `shippingAmount` ([VirtualTerminalShippingAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAmountField.md))
  - `convenienceAmount` ([VirtualTerminalConvenienceFeeField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalConvenienceFeeField.md))
  - `dutyAmount` ([VirtualTerminalDutyAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalDutyAmountField.md))
  - `tipAmount` ([VirtualTerminalTipAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTipAmountField.md))
  - `taxAmount` ([VirtualTerminalTaxField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTaxField.md))
  - `emailAddress` ([VirtualTerminalEmailField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalEmailField.md))

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

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

Properties:
- `settings` ([OrderDataDefaultSettings](https://devportal.demo.winkpg.io/docs/api/models/OrderDataDefaultSettings.md)): The order data default settings values.
  Fields:
  - `enable` (boolean)
  - `applyLevel2DefaultsToApi` (boolean)
  - `applyLevel3DefaultsToApi` (boolean)
  - `applyLevel2DefaultsToVt` (boolean)
  - `applyLevel3DefaultsToVt` (boolean)
  - `applyLevel2DefaultsToHpp` (boolean): Whether Level 2 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every  merchant document written before this toggle existed already had: hosted page transactions were  bucketed under the API toggle. (nullable)
  - `applyLevel3DefaultsToHpp` (boolean): Whether Level 3 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel3DefaultsToApi`". See  `applyLevel2DefaultsToHpp` for why. (nullable)
  - `defaultMerchantZip` (string): Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultTaxRate` (number(double)): Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate.  Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). (nullable, min 0)
  - `defaultShipFromZip` (string): Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultDestinationCountryCode` (string): Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). (nullable, max length 3)
  - `defaultDutyAmount` (number(double)): Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. (nullable, min 0)
  - `defaultFreightAmount` (number(double)): Default freight/shipping amount for L3 enhanced data. (nullable, min 0)
  - `defaultDiscountAmount` (number(double)): Default header-level discount amount for L3 enhanced data. (nullable, min 0)
  - `defaultLineItemValues` ([LineItemDefaults](https://devportal.demo.winkpg.io/docs/api/models/LineItemDefaults.md)): Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
  - `defaultLineItem` ([Level3LineItem](https://devportal.demo.winkpg.io/docs/api/models/Level3LineItem.md)): A template line item that auto-populates as the first line item on new transactions.  Useful for single-product merchants (parking, subscriptions, recurring services).  When null, no template line item is added.
- `concurrencyStamp` (string): Concurrency stamp for optimistic concurrency control. (nullable)
- `isFeatureEnabled` (boolean): Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant.  Read-only: set by the server, ignored on update.
- `virtualTerminalFields` ([VirtualTerminalFields](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalFields.md)): The merchant's Virtual Terminal field configuration at the time of load.  Used by the UI to enforce cross-field constraints (e.g. a default tax rate  requires `taxAmount` to be enabled).  Read-only: set by the server, ignored on update.
  Fields:
  - `customer` ([VirtualTerminalCustomerField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalCustomerField.md))
  - `invoiceNumber` ([VirtualTerminalInvoiceNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalInvoiceNumField.md))
  - `purchaseOrderNumber` ([VirtualTerminalPurchaseOrderNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPurchaseOrderNumField.md))
  - `billingAddress` ([VirtualTerminalBillingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalBillingAddressFieldGroup.md))
  - `shippingAddress` ([VirtualTerminalShippingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAddressFieldGroup.md))
  - `contactPhone` ([VirtualTerminalPhoneField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPhoneField.md))
  - `level3Amount` ([VirtualTerminalLevel3AmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalLevel3AmountField.md))
  - `shippingAmount` ([VirtualTerminalShippingAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAmountField.md))
  - `convenienceAmount` ([VirtualTerminalConvenienceFeeField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalConvenienceFeeField.md))
  - `dutyAmount` ([VirtualTerminalDutyAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalDutyAmountField.md))
  - `tipAmount` ([VirtualTerminalTipAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTipAmountField.md))
  - `taxAmount` ([VirtualTerminalTaxField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTaxField.md))
  - `emailAddress` ([VirtualTerminalEmailField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalEmailField.md))

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

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

Properties:
- `settings` ([OrderDataDefaultSettings](https://devportal.demo.winkpg.io/docs/api/models/OrderDataDefaultSettings.md)): The order data default settings values.
  Fields:
  - `enable` (boolean)
  - `applyLevel2DefaultsToApi` (boolean)
  - `applyLevel3DefaultsToApi` (boolean)
  - `applyLevel2DefaultsToVt` (boolean)
  - `applyLevel3DefaultsToVt` (boolean)
  - `applyLevel2DefaultsToHpp` (boolean): Whether Level 2 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every  merchant document written before this toggle existed already had: hosted page transactions were  bucketed under the API toggle. (nullable)
  - `applyLevel3DefaultsToHpp` (boolean): Whether Level 3 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel3DefaultsToApi`". See  `applyLevel2DefaultsToHpp` for why. (nullable)
  - `defaultMerchantZip` (string): Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultTaxRate` (number(double)): Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate.  Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). (nullable, min 0)
  - `defaultShipFromZip` (string): Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultDestinationCountryCode` (string): Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). (nullable, max length 3)
  - `defaultDutyAmount` (number(double)): Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. (nullable, min 0)
  - `defaultFreightAmount` (number(double)): Default freight/shipping amount for L3 enhanced data. (nullable, min 0)
  - `defaultDiscountAmount` (number(double)): Default header-level discount amount for L3 enhanced data. (nullable, min 0)
  - `defaultLineItemValues` ([LineItemDefaults](https://devportal.demo.winkpg.io/docs/api/models/LineItemDefaults.md)): Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
  - `defaultLineItem` ([Level3LineItem](https://devportal.demo.winkpg.io/docs/api/models/Level3LineItem.md)): A template line item that auto-populates as the first line item on new transactions.  Useful for single-product merchants (parking, subscriptions, recurring services).  When null, no template line item is added.
- `concurrencyStamp` (string): Concurrency stamp for optimistic concurrency control. (nullable)
- `isFeatureEnabled` (boolean): Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant.  Read-only: set by the server, ignored on update.
- `virtualTerminalFields` ([VirtualTerminalFields](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalFields.md)): The merchant's Virtual Terminal field configuration at the time of load.  Used by the UI to enforce cross-field constraints (e.g. a default tax rate  requires `taxAmount` to be enabled).  Read-only: set by the server, ignored on update.
  Fields:
  - `customer` ([VirtualTerminalCustomerField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalCustomerField.md))
  - `invoiceNumber` ([VirtualTerminalInvoiceNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalInvoiceNumField.md))
  - `purchaseOrderNumber` ([VirtualTerminalPurchaseOrderNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPurchaseOrderNumField.md))
  - `billingAddress` ([VirtualTerminalBillingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalBillingAddressFieldGroup.md))
  - `shippingAddress` ([VirtualTerminalShippingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAddressFieldGroup.md))
  - `contactPhone` ([VirtualTerminalPhoneField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPhoneField.md))
  - `level3Amount` ([VirtualTerminalLevel3AmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalLevel3AmountField.md))
  - `shippingAmount` ([VirtualTerminalShippingAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAmountField.md))
  - `convenienceAmount` ([VirtualTerminalConvenienceFeeField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalConvenienceFeeField.md))
  - `dutyAmount` ([VirtualTerminalDutyAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalDutyAmountField.md))
  - `tipAmount` ([VirtualTerminalTipAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTipAmountField.md))
  - `taxAmount` ([VirtualTerminalTaxField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTaxField.md))
  - `emailAddress` ([VirtualTerminalEmailField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalEmailField.md))

## Responses

### 200

OK

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

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

Properties:
- `settings` ([OrderDataDefaultSettings](https://devportal.demo.winkpg.io/docs/api/models/OrderDataDefaultSettings.md)): The order data default settings values.
  Fields:
  - `enable` (boolean)
  - `applyLevel2DefaultsToApi` (boolean)
  - `applyLevel3DefaultsToApi` (boolean)
  - `applyLevel2DefaultsToVt` (boolean)
  - `applyLevel3DefaultsToVt` (boolean)
  - `applyLevel2DefaultsToHpp` (boolean): Whether Level 2 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel2DefaultsToApi`", which is the behaviour every  merchant document written before this toggle existed already had: hosted page transactions were  bucketed under the API toggle. (nullable)
  - `applyLevel3DefaultsToHpp` (boolean): Whether Level 3 defaults apply to Hosted Payment Page transactions.  `null` means "follow `applyLevel3DefaultsToApi`". See  `applyLevel2DefaultsToHpp` for why. (nullable)
  - `defaultMerchantZip` (string): Default merchant zip code for L2 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultTaxRate` (number(double)): Default tax rate for L2/L3 enhanced data. Takes priority over the VT tax field's default rate.  Expressed as a percentage (e.g., 8.25 for 8.25%) or as a decimal (e.g., 0.0825). (nullable, min 0)
  - `defaultShipFromZip` (string): Default ship-from zip code for L3 enhanced data. When set, takes priority over the merchant's contact address zip. (nullable, max length 10)
  - `defaultDestinationCountryCode` (string): Default destination country code for L3 enhanced data (ISO 3166-1 alpha-3, e.g., "USA"). (nullable, max length 3)
  - `defaultDutyAmount` (number(double)): Default duty amount for L3 enhanced data. Set to 0.00 for domestic-only merchants. (nullable, min 0)
  - `defaultFreightAmount` (number(double)): Default freight/shipping amount for L3 enhanced data. (nullable, min 0)
  - `defaultDiscountAmount` (number(double)): Default header-level discount amount for L3 enhanced data. (nullable, min 0)
  - `defaultLineItemValues` ([LineItemDefaults](https://devportal.demo.winkpg.io/docs/api/models/LineItemDefaults.md)): Default field values applied to every new line item added in the Virtual Terminal. Conditional: When DefaultLineItemValues is not null.
  - `defaultLineItem` ([Level3LineItem](https://devportal.demo.winkpg.io/docs/api/models/Level3LineItem.md)): A template line item that auto-populates as the first line item on new transactions.  Useful for single-product merchants (parking, subscriptions, recurring services).  When null, no template line item is added.
- `concurrencyStamp` (string): Concurrency stamp for optimistic concurrency control. (nullable)
- `isFeatureEnabled` (boolean): Whether the `AllowOrderDataDefaultsConfig` feature is enabled for this merchant.  Read-only: set by the server, ignored on update.
- `virtualTerminalFields` ([VirtualTerminalFields](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalFields.md)): The merchant's Virtual Terminal field configuration at the time of load.  Used by the UI to enforce cross-field constraints (e.g. a default tax rate  requires `taxAmount` to be enabled).  Read-only: set by the server, ignored on update.
  Fields:
  - `customer` ([VirtualTerminalCustomerField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalCustomerField.md))
  - `invoiceNumber` ([VirtualTerminalInvoiceNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalInvoiceNumField.md))
  - `purchaseOrderNumber` ([VirtualTerminalPurchaseOrderNumField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPurchaseOrderNumField.md))
  - `billingAddress` ([VirtualTerminalBillingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalBillingAddressFieldGroup.md))
  - `shippingAddress` ([VirtualTerminalShippingAddressFieldGroup](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAddressFieldGroup.md))
  - `contactPhone` ([VirtualTerminalPhoneField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalPhoneField.md))
  - `level3Amount` ([VirtualTerminalLevel3AmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalLevel3AmountField.md))
  - `shippingAmount` ([VirtualTerminalShippingAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalShippingAmountField.md))
  - `convenienceAmount` ([VirtualTerminalConvenienceFeeField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalConvenienceFeeField.md))
  - `dutyAmount` ([VirtualTerminalDutyAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalDutyAmountField.md))
  - `tipAmount` ([VirtualTerminalTipAmountField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTipAmountField.md))
  - `taxAmount` ([VirtualTerminalTaxField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalTaxField.md))
  - `emailAddress` ([VirtualTerminalEmailField](https://devportal.demo.winkpg.io/docs/api/models/VirtualTerminalEmailField.md))

### 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"
  }
}
```

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

**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))

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

### cURL

```bash
curl -X PUT "{{BASE_URL}}/api/merchants/self/order-data-defaults" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
}'
```

### PowerShell

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

$body = @'
{
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
}
'@

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

### 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.merchantsUpdateOrderDataDefaults({
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": false,
  "virtualTerminalFields": {}
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/self/order-data-defaults', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "settings": {},
    "concurrencyStamp": "",
    "isFeatureEnabled": false,
    "virtualTerminalFields": {}
  }),
});

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 MerchantsApi(config);
var body = JsonSerializer.Deserialize<OrderDataDefaultSettingsDto>("""
    {
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": false,
      "virtualTerminalFields": {}
    }
    """);

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

### C# (raw HTTP)

```csharp
using System.Text;

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

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

request.Content = new StringContent("""
    {
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": false,
      "virtualTerminalFields": {}
    }
    """, 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.MerchantsApi(client)
    body = winkpg_api.OrderDataDefaultSettingsDto.from_dict({
      "settings": {},
      "concurrencyStamp": "",
      "isFeatureEnabled": False,
      "virtualTerminalFields": {}
    })
    result = api.merchants_update_order_data_defaults(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "settings": {},
  "concurrencyStamp": "",
  "isFeatureEnabled": False,
  "virtualTerminalFields": {}
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/merchants/self/order-data-defaults",
    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.