Zid Docs

Register ApplePay Domain

POST

https://api.zid.sa/{ProviderUrl}/applepay/register

This endpoint is required for registering a merchant domain with the provider for ApplePay.

Request

Path Params

ProviderUrl

string

required

The base URL of the payment provider’s API. ZidPay will use this URL to send requests such as token generation, payment execution, refunds, and Apple Pay registration. This should point to the root domain or environment-specific endpoint provided by the payment provider.

Example:

https://api.paymentprovider.com

Query Params

domainName

string

optional

The domain that needs to be registered for Apple Pay transactions. This should be the merchant’s website domain and must match the domain used during checkout. It is required for Apple Pay validation.

Header Params

Authorization

string

optional

All secured endpoints require an Authorization header using Basic Authentication. The value should be the secret key provided to the payment provider during integration.

Example:

Authorization: Basic secret_key

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.paymentprovider.com/applepay/register?domainName' \
--header 'Authorization: Authorization: Basic secret_key'

Responses

🟢200OK

application/json

Empty response body. We will rely on the HTTP status code to indicate success / failure. 200 OK status would indicate success.

Body

object {0}

Example

{}

🟠400Invalid input

On Payment Authorized

On Providing Merchant Validation