Update merchant

PUT /api/merchants/{id} deprecated

Requires: Merchants.Merchants.Update, merchant scope.

Updates an existing merchant's account information and settings.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/merchants/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mcc": ""
}'

PowerShell

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

$body = @'
{
  "name": "",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mcc": ""
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/merchants/{id}' `
    -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.merchantsUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "name": "",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mcc": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "mcc": ""
  }),
});

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<MerchantUpdateDto>("""
    {
      "name": "",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "mcc": ""
    }
    """);

var result = await api.MerchantsUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "mcc": ""
    }
    """, 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.MerchantUpdateDto.from_dict({
      "name": "",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "mcc": ""
    })
    result = api.merchants_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "name": "",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mcc": ""
}

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

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`createdFromTemplateId` required	string (uuid)	nullable
`name` required	string	The name of the merchant. nullablemin length 5max length 100
`isActive` required	boolean	Indicates whether the merchant is active.
`resellerId` required	string (uuid)	The unique identifier of the reseller associated with the merchant.
`customIdentifier` required	string	Custom identifier for the merchant. Conditional: When CustomIdentifier is not empty. Length: 5 to 100. nullable
`dba` required	string	Doing Business As (DBA) name for the merchant. Conditional: When Dba is not empty. Length: 5 to 100. nullable
`mcc` required	string	Four-character ISO 18245 Merchant Category Code identifying the merchant's industry. Required for new merchants. Existing merchants without an MCC may load and view, but any save attempt that leaves this null will fail validation. Conditional: When Mcc is not empty. nullable
`isTest` required	boolean	Indicates whether the merchant is a test account.
`environment` required	all of MerchantEnvironment	The merchant's lifecycle environment. nullable
`processorMode` required	all of MerchantProcessorMode	Which processor a sandbox merchant's transactions route to. nullable
`contactDetail` required	all of MerchantContactDetail	Contact details for the merchant.
`businessInfo` required	all of MerchantBusinessInfo	Business information for the merchant.
`virtualTerminal` required	all of VirtualTerminalSettings	Virtual terminal settings for the merchant.
`processing` required	all of ProcessingSettingsDto	Processing settings for the merchant.
`features` required	all of MerchantFeatureSettings	Feature settings for the merchant.
`customFields` required	array of CustomField	Custom fields for the merchant. nullable
`branding` required	all of MerchantBranding	Gets or sets the merchant-level branding configuration for receipts and customer-facing communications.
`accountUpdater` required	all of AccountUpdaterSettingsDto	Account updater settings for the merchant.
`merchantFlowConfig` required	all of MerchantFlowConfig	Gets or sets the optional transaction flow configuration that controls how transactions are orchestrated for this merchant. Conditional: When MerchantFlowConfig is not null.
`billingAssignment` required	all of MerchantBillingAssignment	Gets or sets the billing plan assignment for this merchant. A null value means the merchant has no active billing plan and will be skipped by billing runs. Conditional: When BillingAssignment is not null.
`notes` required	array of EntityNote	Operational notes attached to the merchant. nullable
`digitalWallets` required	array of MerchantDigitalWallet	Per-merchant digital wallet bindings (Apple Pay, Google Pay, …). At most one entry per `WalletProviderType`; each row carries the master enable flag and a pointer to the `WalletProviderRegistration` row this merchant uses (platform-level or merchant-level). nullable
`threeDSBindings` required	array of MerchantThreeDSBinding	Per-merchant 3-D Secure provider bindings. At most one entry per `ThreeDSProviderType`; each row carries the master enable flag, the policy mode, and the vendor credentials. The JWT secret is write-only. It is never returned on a read, so a caller round-tripping a merchant sends null back here; a null or empty secret on a save keeps the one already stored, and a non-empty one replaces it. There is therefore no payload that clears a secret without also removing the binding. Conditional: When ThreeDSBindings is not null. nullable
`taxBindings` required	array of MerchantTaxBinding	Per-merchant tax provider bindings. At most one entry per provider name; each row carries the master enable flag, whose provider account the lookups are billed to, and the provider's configuration values. Secret field values are write-only. They are never returned on a read, so a caller round-tripping a merchant sends null back here; a null or empty secret on a save keeps the one already stored, and a non-empty one replaces it. There is therefore no payload that clears a secret without also removing the binding. A binding whose credential source is `Gateway` must carry no field values: the gateway holds those credentials, and a copy of them on a merchant document is exactly what the credential source exists to avoid. The validator refuses a gateway-sourced binding that supplies any. Conditional: When TaxBindings is not null. nullable
`shippingBindings` required	array of MerchantShippingBinding	Per-merchant shipping rate provider bindings. At most one entry per provider name; each row carries the master enable flag, whose provider account the quotes are billed to, and the provider's configuration values. Secret field values are write-only. They are never returned on a read, so a caller round-tripping a merchant sends null back here; a null or empty secret on a save keeps the one already stored, and a non-empty one replaces it. There is therefore no payload that clears a secret without also removing the binding. A binding whose credential source is `Gateway` must carry no field values: the gateway holds those credentials, and a copy of them on a merchant document is exactly what the credential source exists to avoid. The validator refuses a gateway-sourced binding that supplies any. Conditional: When ShippingBindings is not null. nullable
`paymentEncryptionBindings` required	array of MerchantPaymentEncryptionBinding	Per-merchant payment encryption provider bindings. At most one entry per provider name; each row carries the master enable flag, whose provider account the decryption calls are billed to, the provider's configuration values, and the key serial identifier table. Secret field values and key references are write-only. They are never returned on a read, so a caller round-tripping a merchant sends null back here; a null or empty value on a save keeps the one already stored, and a non-empty one replaces it. There is therefore no payload that clears a secret without also removing the binding or the key entry. A binding whose credential source is `Gateway` must carry no field values: the gateway holds those credentials, and a copy of them on a merchant document is exactly what the credential source exists to avoid. The validator refuses a gateway-sourced binding that supplies any. Key entries are unaffected: a key serial identifier maps the merchant's own devices whichever account the calls are billed to. Conditional: When PaymentEncryptionBindings is not null. nullable
`concurrencyStamp` required	string	Gets or sets the concurrency stamp used for optimistic concurrency control during updates. nullable

This request body has no documented fields.