Move your PayMe account to a new website or platform

Prerequisites

Your PayMe account isn't tied to one website. When you move to a new site, or add another one, you connect the same account there. How you connect depends on how the new site takes payments: through a plugin of the site's platform, or through your own code with the PayMe API. This page covers both, running one account on several sites, and sending payment events to automation tools such as Make or Zapier.

What stays with your account

Step 1: Choose how the new site connects

Your new site How it connects to PayMe
Runs on a platform where you add PayMe as a plugin or app, such as Wix or Shopify Through that plugin. Follow the plugin's own setup, or contact PayMe support.
Your own code, or a site builder or AI tool that lets you run code on a server The PayMe API: step 2

Plugin setup, including which PayMe details a plugin asks for, is in the plugin's own instructions. If they aren't clear, contact PayMe support before you enter any PayMe key into a plugin.

Step 2: Connect your own site with the API

  1. Find your credentials. In the PayMe dashboard, open Admin → API & Integration (API ואינטגרציה). It shows your MPL and your public key. If the page is missing, install the API service from the dashboard app store (חנות אפליקציות) first; depending on your account, it may carry a charge.
  2. Put each key where it belongs. The MPL identifies and authenticates your account on server calls, so it stays on your server. Only the public key may appear in browser code. See Authentication.
  3. Build and test in the sandbox. Open your test account from the dashboard and follow the Quickstart: create a sale, pay it with a test card, receive the callback and refund it.
  4. Go live with the checklist in Get API access and go live.

If an AI tool or site builder writes your code

When the key "doesn't work" on the new site

What you see Usual cause Fix
Error 200 "Merchant was not found" Your MPL was sent as payme_client_key Remove payme_client_key and send seller_payme_id alone. A seller account has no payme_client_key
Error 251 or 163 A sandbox MPL sent to production, or the reverse Use the MPL of the environment you call: https://sandbox.payme.io/api or https://live.payme.io/api
Error 1 No key in the request Send seller_payme_id in the JSON body
Error 21 A callback or return URL that isn't a public address Use your site's public HTTPS address
Error 720 The payment method isn't active on your account Install it from the dashboard app store
Hosted Fields don't accept the key The public key of the other environment, or the wrong testMode Use the public key of the same environment as testMode

More codes are on Errors.

Run one account on several sites

One PayMe account can take payments on several sites at once. They share one account: one balance, one set of payouts and one set of services.

Send payment events to an automation tool

Tools such as Make and Zapier can start a workflow from a PayMe callback.

  1. In the automation tool, create a webhook trigger and copy its URL.
  2. Send that URL as sale_callback_url when you create each sale. PayMe sends a form-encoded POST with fields such as notify_type, payme_sale_id, sale_status and price. A paid sale sends notify_type sale-complete. Every type is on Callback types reference.
  3. Before the workflow acts (ships an order, adds a customer to your CRM), confirm the sale. Add an HTTP step that calls get-sales with your MPL and the callback's payme_sale_id, and check that sale_status is completed and sale_price matches. A seller without a partner key can't verify the callback's payme_signature, so this check is your verification.
{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_payme_id": "SALE1767-704312AB-CD3FGH12-JKLM4567"
}

Switch-over checklist