Create a POS payment

• Sandbox: POST https://sandbox.payme.io/api/sales
• Production: POST https://live.payme.io/api/sales

Credentials

• Request body field seller_payme_id (required): The seller's MPL.
• Request body field payme_client_key (optional): Partners only: your partner key. You can send it in the PayMe-Partner-Key header instead.

Overview

Creates a sale and sends it to a paired POS device, then waits for the buyer to pay on the device. The result comes back in the same response; there is nothing to poll. To refund, see Refund a POS sale.

A declined or canceled payment returns HTTP 200 with status_code 1, status_error_code and status_error_details. Always check status_code, not the HTTP status. For example:

{
  "status_code": 1,
  "payme_status": "error",
  "status_error_code": 20003,
  "status_error_details": "Transaction declined",
  "payme_sale_id": "SALE1700-000000AA-EXAMPLE1-SALE0001",
  "payme_sale_status": "failed"
}

• The seller must have an active POS service (error 720), and the device must be paired and active.
• sale_type sale (default) charges the card; authorize only authorizes it. token returns error 357.
• This call takes the same sale fields as generate-sale, for example installments.
• Setup, pairing and the two-step flow: POS module overview.

Authentication

Send seller_payme_id (the seller's MPL) in the JSON body. Partners also send payme_client_key, in the body or the PayMe-Partner-Key header.

Errors

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Request example

{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_price": 10000,
  "currency": "ILS",
  "product_name": "Coffee beans 1kg",
  "transaction_id": "order-1001",
  "sale_callback_url": "https://www.example.com/payment/callback",
  "payment": {
    "method": "pos",
    "pos_id": "001"
  },
  "customer": {
    "name": "Israel Israeli",
    "email": "buyer@example.com",
    "phone": "0500000000"
  },
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/sales' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_price": 10000,
  "currency": "ILS",
  "product_name": "Coffee beans 1kg",
  "transaction_id": "order-1001",
  "sale_callback_url": "https://www.example.com/payment/callback",
  "payment": {
    "method": "pos",
    "pos_id": "001"
  },
  "customer": {
    "name": "Israel Israeli",
    "email": "buyer@example.com",
    "phone": "0500000000"
  },
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/sales", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sale_price": 10000,
    "currency": "ILS",
    "product_name": "Coffee beans 1kg",
    "transaction_id": "order-1001",
    "sale_callback_url": "https://www.example.com/payment/callback",
    "payment": {
      "method": "pos",
      "pos_id": "001"
    },
    "customer": {
      "name": "Israel Israeli",
      "email": "buyer@example.com",
      "phone": "0500000000"
    },
    "language": "en"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/sales",
    json={
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "sale_price": 10000,
        "currency": "ILS",
        "product_name": "Coffee beans 1kg",
        "transaction_id": "order-1001",
        "sale_callback_url": "https://www.example.com/payment/callback",
        "payment": {
            "method": "pos",
            "pos_id": "001",
        },
        "customer": {
            "name": "Israel Israeli",
            "email": "buyer@example.com",
            "phone": "0500000000",
        },
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_price": 10000,
  "currency": "ILS",
  "product_name": "Coffee beans 1kg",
  "transaction_id": "order-1001",
  "sale_callback_url": "https://www.example.com/payment/callback",
  "payment": {
    "method": "pos",
    "pos_id": "001"
  },
  "customer": {
    "name": "Israel Israeli",
    "email": "buyer@example.com",
    "phone": "0500000000"
  },
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/sales');
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 — The device returned a result: paid (status_code 0) or declined (status_code 1). (success)

{
  "status_code": 0,
  "payme_status": "success",
  "status_error_code": 0,
  "payme_sale_id": "SALE1700-000000AA-EXAMPLE1-SALE0001",
  "payme_sale_code": 12346578,
  "sale_created": "2026-11-09 13:33:54",
  "payme_sale_status": "completed",
  "sale_status": "completed",
  "currency": "ILS",
  "transaction_id": "order-1001",
  "is_token_sale": false,
  "price": 10000,
  "payme_signature": "db1c276**********c5b39",
  "sale_description": "Coffee beans 1kg",
  "sale_deferred_months": null,
  "payme_transaction_id": "TRAN1688-034834SZ-OYNALKNE-DWOXFEUZ",
  "payme_transaction_total": "10000",
  "payme_transaction_card_brand": "Mastercard",
  "payme_transaction_auth_number": "12345678",
  "payme_transaction_voucher": null,
  "payme_transaction_emv_uid": "2306**********102613",
  "payme_transaction_acquirer": "PayMe",
  "payme_transaction_auth_source": "CreditCompany",
  "payme_transaction_card_issuer": "Isracard",
  "payme_transaction_credit_type": "RegularCredit",
  "buyer_name": "Israel Israeli",
  "buyer_email": "buyer@example.com",
  "buyer_phone": "0500000000",
  "buyer_card_mask": "532610******5846",
  "buyer_card_exp": "0426",
  "buyer_card_is_foreign": false,
  "buyer_social_id": null,
  "installments": 1,
  "transaction_first_payment": "10000",
  "transaction_periodical_payment": 0,
  "transaction_arn": "2306**********2613",
  "sale_paid_date": "2026-11-09 13:34:20",
  "sale_release_date": null,
  "sale_3ds": false,
  "redirect_url": null
}

400 — The device or the POS service can't take the payment. See the error table. (error)

{
  "status_code": 1,
  "status_error_details": "Desired device is inactive",
  "status_additional_info": null,
  "status_error_code": 26018,
  "session": "FhT3aXe7"
}

500 — The request was refused. See the error table. (error)

{
  "status_code": 1,
  "status_error_details": "Required parameter is missing",
  "status_additional_info": "currency",
  "status_error_code": 1,
  "session": "FhT3aXe7"
}