Validate ApplePay session

POST

https://api.zen.com/v1/applepay/session

purchase

Service validates whether applepay payment channel should be displayed for the customer in specific transaction on checkout.
If so, ApplePay will be displayed for customer. If no - it will be unavailable in this specific transaction.

Request

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

checkout-version

enum<string>

required

Type of checkout

Allowed values:

securebroker

Body Params application/json

appleUrl

string <uri>

required

initiative

enum<string>

required

Allowed values:

webapp

currency

string

required

Currency code in ISO 4217 alphabetic code

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

Example

{
    "appleUrl": "http://example.com",
    "initiative": "web",
    "currency": "PLN"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zen.com/v1/applepay/session' \
--header 'request-id;' \
--header 'checkout-version;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appleUrl": "http://example.com",
    "initiative": "web",
    "currency": "PLN"
}'

Responses

🟢200OK

application/json

Body

Additional properties

integer | number | string | boolean

optional

Example

{}

🟠404Record Not Found

Modified at 2025-07-10 11:28:41

Renew authorization

Calculate cashback