Get API access and go live: from sandbox to production

Prerequisites

This guide puts the launch steps in order: get the right credentials, open your sandbox account, test what you built, then switch to production with the checklist below. Each step links to the reference page with the details.

Step 1: Know which credentials you need

Credential Who has it What it's for Where to find it
seller_payme_id (the MPL) Every seller Identifies and authenticates the seller on server calls such as generate-sale and refund-sale. Keep it on your server. Dashboard: Admin → API & Integration (API ואינטגרציה)
Public key Every seller, one per environment Browser code: PayMe.create(publicKey, …) for Hosted Fields, Apple Pay and Google Pay The same page, section Hosted Fields JSAPI Credentials
payme_client_key Partners (platforms and marketplaces) only Partner calls such as create-seller, and queries across your sellers Issued by PayMe Partners (partners@payme.io)
Client password Partners only Verifying payme_signature on callbacks Issued together with payme_client_key

Where each credential goes in a request: Authentication.

If the API & Integration page is missing

The page appears once the API service is installed on the account. Install it from the dashboard app store (חנות אפליקציות). Depending on your account, it may carry a charge.

Step 2: Open your sandbox account

The sandbox is free and asks for no signatures.

The test account shows a white top bar, and production a green one. To switch back, click your name → Switch to live account. While the test account is open, Admin → API & Integration shows your sandbox MPL and public key.

A test account can't be converted into a live account. Sandbox tokens (buyer_key) and sandbox MPLs don't work in production.

If you can't open the test account, contact PayMe: https://help.payme.io for dashboard and account questions, partners@payme.io for integration questions.

Step 3: Build and test in the sandbox

Send every sandbox call to https://sandbox.payme.io/api/ with your sandbox credentials. Send "language": "en" to get error messages in English. The Quickstart runs the first checks below with curl.

curl -X POST https://sandbox.payme.io/api/generate-sale \
  -H 'Content-Type: application/json' \
  -d '{
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sale_price": 1000,
    "currency": "ILS",
    "product_name": "Test order",
    "transaction_id": "order-1001",
    "sale_callback_url": "https://your-server.example.com/payme/callback",
    "sale_return_url": "https://your-site.example.com/payment/success",
    "language": "en"
  }'

The callback URL must be a public address even in the sandbox. localhost, private and loopback IP addresses and IPv6 addresses fail the whole call with error 21. See Callback URL rules.

Run these checks before you go live:

Check How What you should see
Create a sale generate-sale, as above status_code 0, a sale_url and a payme_sale_id. Store payme_sale_id with your order.
Pay it Open sale_url and pay with 5326105300985846, expiry 12/30, CVV 658, ID 008336174 The buyer is redirected to sale_return_url
Receive the callback Your sale_callback_url A form-encoded POST with notify_type sale-complete. Reply 200 within 5 seconds.
Confirm the sale get-sales with sale_payme_id sale_status completed and the sale_price of your order
Handle a decline Pay with 4000000000000002 Error 20004, and a sale-failure callback
Refund refund-sale with seller_payme_id and payme_sale_id status_code 0, and a refund callback

If your sales go through 3D Secure, test the challenge too: the cards and the rules that select a sale are on 3D Secure in the sandbox. The challenge code is 555.

All test data, including the other decline cards, Apple Pay cards and bank accounts, is on Test Cards and Payment Methods.

What the sandbox doesn't cover

Step 4: Go-live checklist

Work through every item before your first live sale.

Credentials and URLs

A credential from the other environment fails: a sandbox MPL in production returns 163 or 251, and a partner key from the other environment returns 200. See Errors.

Browser code

Test data

Payment methods and services

Callbacks

Details: Callbacks.

Retries, limits and monitoring

First live payment

Run one real sale for a small amount with your own card, and refund it. Check that the callback arrived and that get-sales shows the sale. If PayMe issues invoices for your sales, check the document on this sale too.

If a key leaks

There is no self-service key rotation. If you think a key has leaked, contact PayMe support at once.

If PayMe moves a partner to a new client key, your API calls can use the new key straight away. The callback signature stays on your primary client key until PayMe completes the switch.

After launch

Partners

If you are a platform or marketplace:

The whole partner flow is on Start here: build a platform or marketplace on PayMe.