List sales

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

Credentials

• Header PayMe-Partner-Key (optional): Partner key, instead of payme_client_key in the body. Partners only.
• Header PayMe-Merchant-Key (optional): A seller's own MPL, instead of seller_payme_id in the body.
• Request body field payme_client_key (optional): Partner key. Partners only. Can also be sent in the PayMe-Partner-Key header. Without seller_payme_id, the query covers all your sellers.
• Request body field seller_payme_id (optional): The seller's MPL. A partner can send one MPL or an array of up to 100 MPLs of its own sellers to narrow the query. A seller sends its own MPL, here or in the PayMe-Merchant-Key header, and gets only its own data.

Returns the sales (orders) of one seller or of all your sellers, with their status, amounts, fees and buyer details. Use it to check where an order stands. For amounts in a period, use List transactions: a refund or chargeback is its own transaction row.

A partner sends payme_client_key (or the PayMe-Partner-Key header) and, optionally, seller_payme_id: one MPL or an array of up to 100 MPLs of its own sellers. Without it, the query covers all your sellers. A seller sends its own MPL as seller_payme_id in the body, or in the PayMe-Merchant-Key header, and gets only its own data.

Defaults: without sale_status, sales in status initial (not paid yet) are left out; send "sale_status": ["initial"] to see them. Without sale_type, tokens (2, 12) and deposits (6) are left out. An unknown sale_status value is ignored.

Filters are exact matches, except sale_created_min / sale_created_max. Most filters take a single value or an array of up to 100 values. Dates are yyyy-mm-dd hh:mm:ss.

Timestamps in the response, and the date filters you send, are Asia/Jerusalem local time, not UTC. A 2–3 hour offset against a UTC clock is the timezone, not a bug.

Results come in pages of up to 500 items (default 500). A call without page and page_size returns only the first 500. Paging, sorting and filter rules are on Query APIs.

Parameters

Request body

Content type: application/json

Every field is optional. Send at least your credentials.

Request example

{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_created_min": "2026-10-01 00:00:00",
  "sale_created_max": "2026-10-31 23:59:59",
  "sale_status": [
    "completed",
    "refunded"
  ],
  "items_order_by_column": "sale_created",
  "page": 1,
  "page_size": 500
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/get-sales' \
  -H 'Content-Type: application/json' \
  -H 'PayMe-Partner-Key: <PayMe-Partner-Key>' \
  -H 'PayMe-Merchant-Key: <PayMe-Merchant-Key>' \
  --data-raw '{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_created_min": "2026-10-01 00:00:00",
  "sale_created_max": "2026-10-31 23:59:59",
  "sale_status": [
    "completed",
    "refunded"
  ],
  "items_order_by_column": "sale_created",
  "page": 1,
  "page_size": 500
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/get-sales", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "PayMe-Partner-Key": "<PayMe-Partner-Key>",
    "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
  },
  body: JSON.stringify({
    "payme_client_key": "XXXXXXXX",
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sale_created_min": "2026-10-01 00:00:00",
    "sale_created_max": "2026-10-31 23:59:59",
    "sale_status": [
      "completed",
      "refunded"
    ],
    "items_order_by_column": "sale_created",
    "page": 1,
    "page_size": 500
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/get-sales",
    headers={
        "PayMe-Partner-Key": "<PayMe-Partner-Key>",
        "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
    },
    json={
        "payme_client_key": "XXXXXXXX",
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "sale_created_min": "2026-10-01 00:00:00",
        "sale_created_max": "2026-10-31 23:59:59",
        "sale_status": [
            "completed",
            "refunded",
        ],
        "items_order_by_column": "sale_created",
        "page": 1,
        "page_size": 500,
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "payme_client_key": "XXXXXXXX",
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "sale_created_min": "2026-10-01 00:00:00",
  "sale_created_max": "2026-10-31 23:59:59",
  "sale_status": [
    "completed",
    "refunded"
  ],
  "items_order_by_column": "sale_created",
  "page": 1,
  "page_size": 500
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/get-sales');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'PayMe-Partner-Key: <PayMe-Partner-Key>',
        'PayMe-Merchant-Key: <PayMe-Merchant-Key>',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

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

echo $response;

Responses

200 — OK (success)

{
  "status_code": 0,
  "items_count": 1,
  "items": [
    {
      "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
      "seller_id": "store-1001",
      "sale_payme_id": "SALE1767-704312AB-CD3FGH12-JKLM4567",
      "sale_payme_code": 98765432,
      "transaction_id": "order-12345",
      "sale_type": 1,
      "sale_payment_method": "credit-card",
      "sale_created": "2026-10-12 15:15:15",
      "sale_status": "completed",
      "sale_currency": "ILS",
      "sale_price": 10000,
      "sale_price_after_fees": "9610",
      "sale_description": "Handmade ceramic bowl",
      "sale_installments": 1,
      "transaction_first_payment": "10000",
      "transaction_periodical_payment": "0",
      "transaction_risk_score": 0,
      "sale_vat": "0.18",
      "sale_paid_date": "2026-10-12 15:16:02",
      "sale_auth_number": "0123456",
      "sale_release_date": "2026-10-19 06:00:00",
      "sale_error_code": null,
      "sale_error_text": "Permitted transaction",
      "sale_url": "https://sandbox.payme.io/sale/generate/SALE1767-704312AB-CD3FGH12-JKLM4567",
      "sale_is_3ds": false,
      "sale_fees": {
        "sale_processing_fee": "2.50",
        "sale_processing_fee_total": 250,
        "sale_processing_charge": "1.20",
        "sale_discount_fee": "0.00",
        "sale_discount_fee_total": 0,
        "sale_rapid_settlement_fee": "0.00",
        "sale_rapid_settlement_fee_total": 0,
        "sale_annual_interest_rate": null,
        "sale_market_fee": "1.50",
        "sale_market_fee_fixed": 0,
        "sale_market_fee_total": 150
      },
      "sale_buyer_details": {
        "buyer_card_mask": "458045******4580",
        "buyer_card_expiry": "1228",
        "buyer_card_brand": "Visa",
        "buyer_card_is_foreign": false,
        "buyer_name": "Israel Israeli",
        "buyer_email": "buyer@example.com",
        "buyer_phone": "0500000001",
        "buyer_social_id": "000000018"
      },
      "sale_invoices": {}
    }
  ]
}

500 — Error. Most errors return HTTP 500. Paging errors (52, 27) return HTTP 400. The body is the same. See Errors. (error)

{
  "status_code": 1,
  "status_error_details": "Required parameter is missing",
  "status_additional_info": "payme_client_key",
  "status_error_code": 1
}