Charge an Israeli direct debit authorization

• Sandbox: POST https://sandbox.payme.io/api/generate-sale
• Production: POST https://live.payme.io/api/generate-sale

Credentials

• Request body field seller_payme_id (required): The seller's MPL, in the JSON body.
• Request body field payme_client_key (optional): Partners only: your partner key (or send the PayMe-Partner-Key header). With seller_payme_id, the seller must belong to you, otherwise error 20.

Overview

Availability. Israeli Direct Debit is offered to high-volume sellers only. It is enabled per account after approval by your PayMe sales representative; it is not self-service. Until then, generate-sale returns 720.

Israeli direct debit works in two phases:

1. Set up the bank authorization and receive its token (buyer_key).
2. Charge the authorization (this page).

POST https://sandbox.payme.io/api/generate-sale (production: https://live.payme.io/api/generate-sale), with a JSON body (Content-Type: application/json).

Charge the authorization

Call generate-sale with:

1. buyer_key – the token from the authorization setup;
2. sale_type: sale;
3. sale_payment_method: il-direct-debit.

The call submits the debit at once: there is no payment page and no sale_url. The token's own payment method is used either way.

Constraints:

• currency must be ILS (otherwise error 320).
• The token must be active: the setup's sale-complete callback has arrived. A token whose authorization isn't active yet, was rejected or was revoked returns 604.
• Installments aren't allowed (351).

Credentials

Send seller_payme_id (the MPL) in the JSON body: this endpoint doesn't read the PayMe-Merchant-Key header, so a request without a body MPL returns error 1. Partners add payme_client_key (or the PayMe-Partner-Key header) and may name the seller by seller_id instead. See Authentication.

Callbacks

The fields are on Callbacks.

Testing

Sandbox bank accounts are on Test Cards and Payment Methods.

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",
  "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567",
  "sale_type": "sale",
  "sale_payment_method": "il-direct-debit",
  "sale_price": 1000,
  "currency": "ILS",
  "product_name": "Monthly membership",
  "transaction_id": "order-1003",
  "sale_callback_url": "https://your-server.example.com/payme/callback",
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/generate-sale' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567",
  "sale_type": "sale",
  "sale_payment_method": "il-direct-debit",
  "sale_price": 1000,
  "currency": "ILS",
  "product_name": "Monthly membership",
  "transaction_id": "order-1003",
  "sale_callback_url": "https://your-server.example.com/payme/callback",
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/generate-sale", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567",
    "sale_type": "sale",
    "sale_payment_method": "il-direct-debit",
    "sale_price": 1000,
    "currency": "ILS",
    "product_name": "Monthly membership",
    "transaction_id": "order-1003",
    "sale_callback_url": "https://your-server.example.com/payme/callback",
    "language": "en"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/generate-sale",
    json={
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567",
        "sale_type": "sale",
        "sale_payment_method": "il-direct-debit",
        "sale_price": 1000,
        "currency": "ILS",
        "product_name": "Monthly membership",
        "transaction_id": "order-1003",
        "sale_callback_url": "https://your-server.example.com/payme/callback",
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567",
  "sale_type": "sale",
  "sale_payment_method": "il-direct-debit",
  "sale_price": 1000,
  "currency": "ILS",
  "product_name": "Monthly membership",
  "transaction_id": "order-1003",
  "sale_callback_url": "https://your-server.example.com/payme/callback",
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/generate-sale');
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 — Debit submitted. The response holds the sale and transaction fields and has no sale_url. A refused charge also returns HTTP 200, with status_code: 1: always check status_code. (success)

{
  "status_code": 0,
  "payme_status": "success",
  "payme_sale_id": "SALE1700-000000AA-EXAMPLE1-SALE0001",
  "payme_sale_code": 12345678,
  "sale_status": "initial",
  "sale_payment_method": "il-direct-debit",
  "price": 1000,
  "currency": "ILS",
  "transaction_id": "order-1003",
  "payme_transaction_id": "TRAN1700-000000AA-EXAMPLE1-TXN00001",
  "payme_transaction_total": 1000,
  "payme_signature": "f8ffc5bb45fe6c3ad326c439f1a21c28",
  "sale_paid_date": "2026-11-09 10:15:02"
}

500 — Request refused. Most request errors return HTTP 500 with status_code: 1; some return 400, 403, 422 or 429. See Errors. (error)

{
  "status_code": 1,
  "status_error_details": "Seller was not found",
  "status_additional_info": "seller_payme_id",
  "status_error_code": 251,
  "session": "AtsJ0as5"
}