Apple Pay: get certificate status.

GET /api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status deprecated

Requires: PaymentTokenization.SettingManagement, merchant scope.

Returns the current lifecycle status of the given certificate type, including thumbprint and validity dates. This is a read-only check; it never mutates Key Vault.

Try this in the console

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status' `
    -Headers $headers

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.applePayCertificatesGetStatus("TYPE");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new WalletsApi(config);
var result = await api.ApplePayCertificatesGetStatusAsync("TYPE");

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status");
request.Headers.Add("api-key", "{{API_KEY}}");

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)
    result = api.apple_pay_certificates_get_status("TYPE")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/payment-tokenization/wallet-providers/apple-pay/certificates/{type}/status",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`type` required	path	ApplePayCertificateType	Which Apple Pay cert flow the controller is acting on. Mirrors the `AppleCertificateType` enum defined in the ApplePay provider but kept here so HttpApi callers don't need to reference the provider assembly.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: ApplePayCertificateStatusOutput Each item has these fields.

Field	Type	Description
`type` required	string	nullable
`status` required	string	nullable
`certificateName` required	string	Key Vault certificate/secret name backing this cert (read from Key Vault). nullable
`thumbprint` required	string	nullable
`notBefore` required	string (date-time)	Certificate activation date (NotBefore), read from Key Vault. nullable
`notAfter` required	string (date-time)	Certificate expiration date (NotAfter), read from Key Vault. nullable
`hasPendingRenewal` required	boolean	True when a renewal CSR is in flight on top of an already-active certificate. Orthogonal to `status`: the value here is whether the panel should surface in-progress renewal actions (download CSR / complete / cancel) instead of a Rotate button. Always false when no active cert exists: in that case the pending state is already reflected in `status`.

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. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded. 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.

Body: RateLimitProblemDetails Each item has these fields.

Field	Type	Description
`type` required	string	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` required	string	A short, human-readable summary of the problem type. nullable
`status` required	integer (int32)	The HTTP status code, repeated in the body as the problem-details format defines.
`detail` required	string	A human-readable explanation of this occurrence of the problem. nullable
`retryAfterSeconds` required	integer (int32)	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.

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: get certificate status.

Example request

Parameters

Request body

Responses

200 OK

429 The request was refused because a rate limit was exceeded. 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.

Errors

Authentication