Create a WalletProviderRegistration

POST /api/payment-tokenization/wallet-providers deprecated

Requires: PaymentTokenization.PaymentTokenizations, PaymentTokenization.PaymentTokenizations.Create, merchant scope.

Create a new WalletProviderRegistration

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/payment-tokenization/wallet-providers" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantDisplayName": "",
  "merchantUrl": ""
}'

PowerShell

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

$body = @'
{
  "merchantDisplayName": "",
  "merchantUrl": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/payment-tokenization/wallet-providers' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, WalletsApi } from '@winkpg/winkpg-api';

const api = new WalletsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.walletProvidersCreate({
  "merchantDisplayName": "",
  "merchantUrl": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/payment-tokenization/wallet-providers', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantDisplayName": "",
    "merchantUrl": ""
  }),
});

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 WalletsApi(config);
var body = JsonSerializer.Deserialize<WalletProviderRegistrationCreateDto>("""
    {
      "merchantDisplayName": "",
      "merchantUrl": ""
    }
    """);

var result = await api.WalletProvidersCreateAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/payment-tokenization/wallet-providers");
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();

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.WalletsApi(client)
    body = winkpg_api.WalletProviderRegistrationCreateDto.from_dict({
      "merchantDisplayName": "",
      "merchantUrl": ""
    })
    result = api.wallet_providers_create(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "merchantDisplayName": "",
  "merchantUrl": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/payment-tokenization/wallet-providers",
    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.

Request body

application/json , required

Field	Type	Description
`providerType` required	all of WalletProviderType	Wallet provider this operation targets.
`level` required	all of WalletRegistrationLevel	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` required	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. nullable
`providerMerchantIdentifier` required	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). nullablemax length 128
`gatewayMerchantId` required	string	The merchant's identifier <b>at this gateway</b>, 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. nullable
`merchantDisplayName` required	string	Merchant display name surfaced to the wallet provider. nullablemax length 256
`merchantUrl` required	string	Canonical merchant URL. Must be an absolute HTTPS URL. nullable
`domains` required	array of string	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). nullable
`isSandbox` required	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` required	all of WalletMerchantOnboardingInput	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).

This request body has no documented fields.