Enable Apple Pay for a seller

• Sandbox: POST https://sandbox.payme.io/api/vas-enable
• Production: POST https://live.payme.io/api/vas-enable

Credentials

• Request body field payme_client_key (required): Your partner key. Keep it on your server.
• Request body field seller_payme_id (required): The seller's PayMe ID (MPL). The seller must belong to your partner.

Enables Apple Pay for one of your sellers and registers the domains that show the Apple Pay button on your own pages. Partner-only: authenticate with payme_client_key. A seller can install Apple Pay itself from the dashboard app store (חנות אפליקציות). Base URL: https://sandbox.payme.io/api in the sandbox, https://live.payme.io/api in production.

What happens

For each domain in vas_data.websites, PayMe fetches https://<domain>/.well-known/apple-developer-merchantid-domain-association and compares it byte for byte with PayMe's file for the environment you call. The sandbox and production files differ: see Host PayMe's domain file. If every domain passes, PayMe registers the domains with Apple in the same call and returns the approved ones in vas_data.websites, together with PayMe's own host.

• Up to 99 domains per call. A domain can be sent with or without https://.
• To add domains later, call vas-enable again with the new ones. Approved domains stay approved. (Partners can also use vas-update; contact PayMe support for its details.)

Errors

See Accept Apple Pay for the whole setup.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Request example

{
  "payme_client_key": "payme_partner_key",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
  "vas_data": {
    "websites": [
      "example.com",
      "shop.example.com"
    ]
  },
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/vas-enable' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "payme_client_key": "payme_partner_key",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
  "vas_data": {
    "websites": [
      "example.com",
      "shop.example.com"
    ]
  },
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/vas-enable", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "payme_client_key": "payme_partner_key",
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
    "vas_data": {
      "websites": [
        "example.com",
        "shop.example.com"
      ]
    },
    "language": "en"
  }),
});

console.log(await response.text());

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/vas-enable",
    json={
        "payme_client_key": "payme_partner_key",
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
        "vas_data": {
            "websites": [
                "example.com",
                "shop.example.com",
            ],
        },
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "payme_client_key": "payme_partner_key",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
  "vas_data": {
    "websites": [
      "example.com",
      "shop.example.com"
    ]
  },
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/vas-enable');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Apple Pay is enabled and the domains are registered. (success)

{
  "status_code": 0,
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "vas_payme_id": "VASLDEMO-VASLDEMO-VASLDEMO-1234567",
  "vas_guid": "VASLDEMO-VASLDEMO-VASLDEMO-7654321",
  "vas_type": "AlternativePaymentMethod",
  "vas_name": null,
  "vas_is_active": true,
  "vas_payer_type": 2,
  "vas_price_currency": "ILS",
  "vas_price_setup_fixed": 0,
  "vas_price_periodic_fixed": 0,
  "vas_price_periodic_variable": "0.00",
  "vas_price_usage_fixed": 0,
  "vas_price_usage_variable": "0.00",
  "vas_market_fee": null,
  "vas_period": 1,
  "vas_data": {
    "websites": [
      "example.com",
      "shop.example.com"
    ]
  }
}

400 — A domain failed the check (703), or Apple refused the registration (20). (error)

{
  "status_code": 1,
  "status_error_details": "Action is not permitted",
  "status_additional_info": "shop.example.com: Certificate does not match, please reconfigure.",
  "status_error_code": 703
}

500 — The service was not activated (720). (error)

{
  "status_code": 1,
  "status_error_details": "The service was not activated",
  "status_additional_info": null,
  "status_error_code": 720
}