Apple Pay: create an Apple Pay merchant session.

POST /api/payment-tokenization/apple-pay/session deprecated

No permission required.

Requires API key scope: tokens (Payment tokens)

Called by the storefront's `onvalidatemerchant` callback. Proxies the supplied Apple validation URL to Apple over the platform Identity certificate and returns the merchant session payload the browser relays to `ApplePaySession.completeMerchantValidation()`. The validation URL is SSRF-guarded to Apple hosts, and the requested domain must already be verified for the merchant.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/payment-tokenization/apple-pay/session" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validationUrl": "",
  "initiativeContext": ""
}'

PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validationUrl": "",
  "initiativeContext": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/payment-tokenization/apple-pay/session' `
    -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.applePayCheckoutCreateSession({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validationUrl": "",
  "initiativeContext": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/payment-tokenization/apple-pay/session', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "validationUrl": "",
    "initiativeContext": ""
  }),
});

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<CreateWalletPaymentSessionInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validationUrl": "",
      "initiativeContext": ""
    }
    """);

var result = await api.ApplePayCheckoutCreateSessionAsync(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/apple-pay/session");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validationUrl": "",
      "initiativeContext": ""
    }
    """, 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.CreateWalletPaymentSessionInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validationUrl": "",
      "initiativeContext": ""
    })
    result = api.apple_pay_checkout_create_session(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validationUrl": "",
  "initiativeContext": ""
}

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

providerType required

WalletProviderType WalletProviderType

Defines the supported wallet provider types used for payment tokenization.

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.

`Unknown`	Unknown wallet provider.
`ApplePay`	Apple Pay wallet provider.
`GooglePay`	Google Pay wallet provider.
`NetworkToken`	Network tokenization provider (Visa, Mastercard etc).
`Paze`	Paze (Early Warning) wallet provider.

merchantId required

string (uuid)

Identifier of the merchant the shopper is checking out with. The server reads this merchant's `DigitalWallets[]` to resolve which `WalletProviderRegistration` row to use; the resolution may land on a platform-level row (merchant inherits) or a merchant-level row (merchant brought its own integrator), depending entirely on what the merchant has bound.

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.

validationUrl required

string

Provider-supplied validation URL (Apple Pay JS supplies it via `onvalidatemerchant`; the controller MUST NOT substitute it). Conditional: When IsValid(ValidationUrl) is true. 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.

initiativeContext required

string

Fully-qualified initiating domain. For Apple Pay this is the `initiativeContext`; must be one of the merchant's verified domains. nullablemax length 256

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: WalletPaymentSessionOutput WalletPaymentSessionOutput Each item has these fields.

Field Type Description

providerType required

WalletProviderType WalletProviderType

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.

`Unknown`	Unknown wallet provider.
`ApplePay`	Apple Pay wallet provider.
`GooglePay`	Google Pay wallet provider.
`NetworkToken`	Network tokenization provider (Visa, Mastercard etc).
`Paze`	Paze (Early Warning) wallet provider.

sessionPayload required

string

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

The API reference isn't available right now

No such operation

This reference may be out of date

Apple Pay: create an Apple Pay merchant session.

Example request

Parameters

Request body

Responses

200 OK

Errors

Authentication