Capture an authorized sale

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

Credentials

• Request body field payme_client_key (optional): Partners: your partner key. You can send it in the PayMe-Partner-Key header instead. A seller leaves it out.
• Request body field seller_payme_id (optional): The seller's MPL. Required unless you send seller_id with payme_client_key.

Overview

Charges a sale that was authorized with sale_type: "authorize". Capture once, for the authorized amount or less, within 7 days of the authorization. To capture in several parts, use multi-capture. The whole flow is in Authorize now, capture later.

Credentials

The same as refund-sale: send seller_payme_id, or seller_id with your partner key (payme_client_key). A partner key on its own fails with error 1. The sale must belong to the seller you name.

Rules

• The sale must be authorized. A sale whose capture was declined (failed) can be captured again while the authorization is still valid. Any other status returns error 305, with the status in status_additional_info.
• Leave out sale_price to capture the full authorized amount; send a lower sale_price to capture less.
• sale_price must be at least the account's minimum sale value (500 by default) and at most the authorized amount, unless PayMe has set a higher capture limit on your account. 0 or an amount outside these limits returns 352; a decimal returns 42.
• More than 7 days (168 hours) after the authorization, the call fails with 516. The error doesn't release the hold: void it with refund-sale.
• 518 means the sale's authorization is no longer open, for example because the authorization failed.

Result

A successful capture returns the sale with sale_status: "completed", and PayMe sends a sale-complete callback. A declined capture returns HTTP 200 with status_code: 1, status_error_code and status_error_details, and the sale becomes failed; you can retry while the authorization is still valid and within the 7 days.

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",
  "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "sale_price": 8000,
  "language": "en"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/capture-sale' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "sale_price": 8000,
  "language": "en"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/capture-sale", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
    "sale_price": 8000,
    "language": "en"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/capture-sale",
    json={
        "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
        "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
        "sale_price": 8000,
        "language": "en",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
  "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "sale_price": 8000,
  "language": "en"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/capture-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 — The capture result: captured (status_code 0) or declined (1). A decline also returns HTTP 200. (success)

{
  "status_code": 0,
  "status_error_code": 0,
  "payme_status": "success",
  "payme_sale_id": "SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "payme_sale_code": 1111111,
  "sale_created": "2026-11-09 10:15:02",
  "sale_status": "completed",
  "payme_sale_status": "completed",
  "sale_type": "Sale",
  "sale_payment_method": "credit-card",
  "currency": "ILS",
  "price": 8000,
  "transaction_id": "order-1234",
  "sale_description": "Shirt",
  "sale_deferred_months": null,
  "is_token_sale": false,
  "payme_signature": "b71e**************ca5a",
  "payme_transaction_id": "TRANDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "payme_transaction_total": "8000",
  "payme_transaction_card_brand": "Mastercard",
  "payme_transaction_auth_number": "0123456",
  "payme_transaction_voucher": "111111",
  "payme_transaction_emv_uid": null,
  "payme_transaction_acquirer": "PayMe",
  "payme_transaction_auth_source": "VoiceMail",
  "payme_transaction_card_issuer": "Isracard",
  "payme_transaction_credit_type": "RegularCredit",
  "buyer_name": "Israel Israeli",
  "buyer_email": "buyer@example.com",
  "buyer_phone": null,
  "buyer_card_mask": "532610******5846",
  "buyer_card_exp": "1230",
  "buyer_card_is_foreign": false,
  "buyer_social_id": "008336174",
  "installments": 1,
  "transaction_first_payment": 8000,
  "transaction_periodical_payment": 0,
  "transaction_arn": null,
  "sale_paid_date": "2026-11-09 10:16:40",
  "sale_release_date": null,
  "sale_3ds": false,
  "session": "Ab12Cd34"
}

400 — Error 1: no seller named (a partner key on its own). Error 352: sale_price is above the authorized amount (or your capture limit). Error 20: the seller doesn't belong to the partner key sent. (error)

{
  "status_code": 1,
  "status_error_details": "Invalid price, out of min-max bounds",
  "status_additional_info": "12000",
  "status_error_code": 352,
  "session": "Ab12Cd34"
}

403 — Error 303: the sale belongs to another partner or another seller. (error)

{
  "status_code": 1,
  "status_error_details": "Could not access sale",
  "status_additional_info": "",
  "status_error_code": 303,
  "session": "Ab12Cd34"
}

429 — Error 998: another call for this sale is still running, or too many requests. Wait, then check the sale before retrying. (error)

{
  "status_code": 1,
  "status_error_details": "Operation is not permitted",
  "status_additional_info": "Duplicated action detected, please retry later",
  "status_error_code": 998,
  "session": "Ab12Cd34"
}

500 — Request errors. 1: a required field is missing. 350: no sale has this ID. 305: the sale isn't authorized or failed. 518: the authorization is no longer open. 516: more than 7 days since the authorization. 352: sale_price below the account minimum. 42: sale_price isn't a whole number. 351: invalid installments. 251: unknown seller. (error)

{
  "status_code": 1,
  "status_error_details": "Sale authorization has been expired",
  "status_additional_info": "",
  "status_error_code": 516,
  "session": "Ab12Cd34"
}