Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Providing Merchant Validation

POST

https://api.zid.sa/{providerBaseURL}/applepay/initiate

When the merchant validation event is triggered from the Apple Pay JS library, a request to the provider will be needed to obtain the merchant session object that is needed to validate the merchant session. The provider API in turn shall call Apple endpoint “startSession” to get an apple session and return it.

Request

Path Params

Body Params application/json

Example

{
    "validationUrl": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
    "displayName": "Zid Store",
    "domainName": "www.example.com",
    "publishableApiKey": "pk_test_abc123xyz"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.paymentprovider.com/applepay/initiate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "validationUrl": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
    "displayName": "Zid Store",
    "domainName": "www.example.com",
    "publishableApiKey": "pk_test_abc123xyz"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "merchantSession": {}
}

Modified at 2025-12-01 19:35:48

Request Refund