# PUT /api/payment-tokenization/wallet-providers/{id} Update a WalletProviderRegistration Update an existing WalletProviderRegistration by id **Operation ID:** `walletProvidersUpdate` ## Authorization Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Update, merchant scope. Required permissions: - `PaymentTokenization.PaymentTokenizations` - `PaymentTokenization.PaymentTokenizations.Update` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | id | path | yes | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: `WalletProviderRegistrationUpdateDto` Properties: - `providerType` (object): Wallet provider this operation targets. - `level` (object): Scope of the registration. `Platform` must be paired with `merchantId` = null; `Merchant` must be paired with a non-null `merchantId`. Server-side validation rejects any other combination. - `merchantId` (string(uuid)): Identifier of the merchant this registration belongs to. Required when `level` = `Merchant`; must be null when `level` = `Platform`. Conditional: When ForbidsMerchantId(Level) is true. Required: When RequiresMerchantId(Level) is true. - `providerMerchantIdentifier` (string): Provider-side identifier: the value the wallet provider should use for this merchant going forward. Free-form when allowed by the provider (Apple Pay accepts any partner-supplied string). Required: Conditional (see validator source). - `gatewayMerchantId` (string): The merchant's identifier at this gateway, required by a provider whose model round-trips one. Google Pay sends it to the browser as `tokenizationSpecification.parameters.gatewayMerchantId` and copies it into the encrypted payment token, so the decrypted message says which merchant the shopper believed they were paying. - `merchantDisplayName` (string) required: Merchant display name surfaced to the wallet provider. - `merchantUrl` (string) required: Canonical merchant URL. Must be an absolute HTTPS URL. - `domains` (array): Domains to register. Apple Pay accepts multiple; Paze accepts exactly one (the HPP SDK initializes with a single profile id, so a Paze registration maps to one domain / one profile: enforced by the validator). Each domain must already host the provider-specified verification file before this call is made. Required: Conditional (see validator source). - `isSandbox` (boolean): Platform-level gateway environment toggle: `true` = Sandbox, `false` = Production (default). Honored only when `level` = `Platform`; merchant-level rows ignore it and derive the environment from the merchant's `IsTest` flag. - `onboarding` (object): Richer onboarding details for providers whose registration contract needs them (see `WalletProviderRegistrationTraits.RequiresOnboardingDetails`: Paze today). Required for those providers, and ignored for the rest. Required: Conditional (see validator source). - `concurrencyStamp` (string) **Content type:** `text/json` Schema: `WalletProviderRegistrationUpdateDto` Properties: - `providerType` (object): Wallet provider this operation targets. - `level` (object): Scope of the registration. `Platform` must be paired with `merchantId` = null; `Merchant` must be paired with a non-null `merchantId`. Server-side validation rejects any other combination. - `merchantId` (string(uuid)): Identifier of the merchant this registration belongs to. Required when `level` = `Merchant`; must be null when `level` = `Platform`. Conditional: When ForbidsMerchantId(Level) is true. Required: When RequiresMerchantId(Level) is true. - `providerMerchantIdentifier` (string): Provider-side identifier: the value the wallet provider should use for this merchant going forward. Free-form when allowed by the provider (Apple Pay accepts any partner-supplied string). Required: Conditional (see validator source). - `gatewayMerchantId` (string): The merchant's identifier at this gateway, required by a provider whose model round-trips one. Google Pay sends it to the browser as `tokenizationSpecification.parameters.gatewayMerchantId` and copies it into the encrypted payment token, so the decrypted message says which merchant the shopper believed they were paying. - `merchantDisplayName` (string) required: Merchant display name surfaced to the wallet provider. - `merchantUrl` (string) required: Canonical merchant URL. Must be an absolute HTTPS URL. - `domains` (array): Domains to register. Apple Pay accepts multiple; Paze accepts exactly one (the HPP SDK initializes with a single profile id, so a Paze registration maps to one domain / one profile: enforced by the validator). Each domain must already host the provider-specified verification file before this call is made. Required: Conditional (see validator source). - `isSandbox` (boolean): Platform-level gateway environment toggle: `true` = Sandbox, `false` = Production (default). Honored only when `level` = `Platform`; merchant-level rows ignore it and derive the environment from the merchant's `IsTest` flag. - `onboarding` (object): Richer onboarding details for providers whose registration contract needs them (see `WalletProviderRegistrationTraits.RequiresOnboardingDetails`: Paze today). Required for those providers, and ignored for the rest. Required: Conditional (see validator source). - `concurrencyStamp` (string) **Content type:** `application/*+json` Schema: `WalletProviderRegistrationUpdateDto` Properties: - `providerType` (object): Wallet provider this operation targets. - `level` (object): Scope of the registration. `Platform` must be paired with `merchantId` = null; `Merchant` must be paired with a non-null `merchantId`. Server-side validation rejects any other combination. - `merchantId` (string(uuid)): Identifier of the merchant this registration belongs to. Required when `level` = `Merchant`; must be null when `level` = `Platform`. Conditional: When ForbidsMerchantId(Level) is true. Required: When RequiresMerchantId(Level) is true. - `providerMerchantIdentifier` (string): Provider-side identifier: the value the wallet provider should use for this merchant going forward. Free-form when allowed by the provider (Apple Pay accepts any partner-supplied string). Required: Conditional (see validator source). - `gatewayMerchantId` (string): The merchant's identifier at this gateway, required by a provider whose model round-trips one. Google Pay sends it to the browser as `tokenizationSpecification.parameters.gatewayMerchantId` and copies it into the encrypted payment token, so the decrypted message says which merchant the shopper believed they were paying. - `merchantDisplayName` (string) required: Merchant display name surfaced to the wallet provider. - `merchantUrl` (string) required: Canonical merchant URL. Must be an absolute HTTPS URL. - `domains` (array): Domains to register. Apple Pay accepts multiple; Paze accepts exactly one (the HPP SDK initializes with a single profile id, so a Paze registration maps to one domain / one profile: enforced by the validator). Each domain must already host the provider-specified verification file before this call is made. Required: Conditional (see validator source). - `isSandbox` (boolean): Platform-level gateway environment toggle: `true` = Sandbox, `false` = Production (default). Honored only when `level` = `Platform`; merchant-level rows ignore it and derive the environment from the merchant's `IsTest` flag. - `onboarding` (object): Richer onboarding details for providers whose registration contract needs them (see `WalletProviderRegistrationTraits.RequiresOnboardingDetails`: Paze today). Required for those providers, and ignored for the rest. Required: Conditional (see validator source). - `concurrencyStamp` (string) ## Responses ### 200 OK **Content type:** `application/json` Schema: `WalletProviderRegistrationDto` Properties: - `extraProperties` (object) - `id` (string(uuid)) - `creationTime` (string(date-time)): The date and time when this entity was created. - `creatorId` (string(uuid)): The ID of the user who created this entity. - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. - `isDeleted` (boolean): Indicates whether this entity has been deleted. - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. - `merchantId` (string(uuid)) - `tenantId` (string(uuid)) - `concurrencyStamp` (string) - `entityVersion` (integer(int32)): Increases whenever the entity is changed. - `name` (string) - `providerType` (object) - `status` (object) - `level` (object): Derived scope: `Platform` when `merchantId` is null, otherwise `Merchant`. Computed on every read. - `domainVerifications` (array) - `providerMerchantIdentifier` (string): Provider-side merchant identifier persisted at registration time. - `gatewayMerchantId` (string): The merchant's identifier at this gateway, persisted at registration time for a provider whose model round-trips one (Google Pay). Null for every other provider. - `merchantDisplayName` (string): Merchant display name persisted at registration time. - `merchantUrl` (string): Canonical merchant URL persisted at registration time. - `isSandbox` (boolean): Platform-row gateway environment: `true` = Sandbox, `false` = Production. Persisted only for platform-level rows; merchant-level rows derive their environment live from the merchant's Test mode, so this stays `false` for them. - `profileId` (string): Profile id, for providers with a profile model (Paze: needed by the HPP SDK alongside the client id). Single per registration (Paze is single-domain / single-profile). - `merchantCategoryCode` (string): Merchant category code (ISO 18245). - `merchantAddress` (object): Business address registered with the provider. Stored as one JSON string in `ProviderMetadata`; deserialized to the structured shape by the AutoMapper profile so consumers never touch the raw JSON. ### 403 Forbidden **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 401 Unauthorized **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 400 Bad Request **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 404 Not Found **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 501 Not Implemented **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 500 Internal Server Error **Content type:** `application/json` Schema: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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: `RemoteServiceErrorResponse` Properties: - `error` (RemoteServiceErrorInfo) ### 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` 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. - `title` (string) required: A short, human-readable summary of the problem type. - `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. - `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` Properties: - `error` (RemoteServiceErrorInfo) ## 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 WalletProviderRegistrationUpdateDto. See the Request body section below for its fields. ### cURL ```bash curl -X PUT "{{BASE_URL}}/api/payment-tokenization/wallet-providers/{id}" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "merchantDisplayName": "", "merchantUrl": "" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "merchantDisplayName": "", "merchantUrl": "" } '@ $response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/payment-tokenization/wallet-providers/{id}' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, WalletsApi } from '@winkpg/winkpg-api'; const api = new WalletsApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.walletProvidersUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", { "merchantDisplayName": "", "merchantUrl": "" }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/payment-tokenization/wallet-providers/{id}', { method: 'PUT', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "merchantDisplayName": "", "merchantUrl": "" }), }); 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 WalletsApi(config); var body = JsonSerializer.Deserialize(""" { "merchantDisplayName": "", "merchantUrl": "" } """); var result = await api.WalletProvidersUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/payment-tokenization/wallet-providers/{id}"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "merchantDisplayName": "", "merchantUrl": "" } """, 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.WalletsApi(client) body = winkpg_api.WalletProviderRegistrationUpdateDto.from_dict({ "merchantDisplayName": "", "merchantUrl": "" }) result = api.wallet_providers_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "merchantDisplayName": "", "merchantUrl": "" } response = requests.request( "PUT", "{{BASE_URL}}/api/payment-tokenization/wallet-providers/{id}", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.