Get a document

• Sandbox: GET https://sandbox.payme.io/api/documents/{document_id}
• Production: GET https://live.payme.io/api/documents/{document_id}

Credentials

• Header PayMe-Merchant-Key (API key)
• Header PayMe-Partner-Key (optional): Partners only: your partner key. The seller must belong to you (error 20).

⚠️ This API is deprecated and is no longer recommended for use. For questions, contact partners@payme.io.

Overview

Returns a document created with Create a document. document_id is the doc_id that call returned. The seller's invoicing service must be active; otherwise every documents call returns error 703 (HTTP 403).

Documents are created asynchronously. While the document job is still running (its status is waiting, active, delayed, paused or stuck), this call returns error 1005 with HTTP 400 and the status in status_additional_info, for example status:waiting. Wait a few seconds and call it again.

If the job failed, the call returns error 1003. If the invoicing service reports an unknown job status, the response is HTTP 200 with status_code 0 and no document fields: call again later.

Example: GET https://sandbox.payme.io/api/documents/fa397fce-aee6-4c6d-ae9c-273ae1e3a317 with the header PayMe-Merchant-Key: MPLDEMO-MPLDEMO-MPLDEMO-1234567.

Errors

Parameters

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/documents/<document_id>' \
  -H 'PayMe-Merchant-Key: <PayMe-Merchant-Key>' \
  -H 'PayMe-Partner-Key: <PayMe-Partner-Key>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/documents/<document_id>", {
  method: "GET",
  headers: {
    "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
    "PayMe-Partner-Key": "<PayMe-Partner-Key>",
  },
});

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

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/documents/<document_id>",
    headers={
        "PayMe-Merchant-Key": "<PayMe-Merchant-Key>",
        "PayMe-Partner-Key": "<PayMe-Partner-Key>",
    },
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/documents/<document_id>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'PayMe-Merchant-Key: <PayMe-Merchant-Key>',
        'PayMe-Partner-Key: <PayMe-Partner-Key>',
    ],
]);

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

echo $response;

Responses

200 — The document is ready. (success)

{
  "status_code": 0,
  "doc_type": 400,
  "buyer_name": "Israel Israeli",
  "doc_date": "2026-11-09",
  "currency": "ILS",
  "language": "he",
  "doc_title": "Receipt for order 1001",
  "total_paid": 140,
  "items": [
    {
      "description": "Monthly plan",
      "quantity": 1,
      "unit_price": 140,
      "vat_exempt": false,
      "currency": "ILS"
    }
  ],
  "cash": {
    "sum": 40
  },
  "credit_card": {
    "sum": 100,
    "installments": 1,
    "type": "Visa",
    "expiry": "1230",
    "buyer_name": "Israel Israeli",
    "auth_number": "0123456"
  },
  "doc_id": "fa397fce-aee6-4c6d-ae9c-273ae1e3a317",
  "doc_num": "10023",
  "doc_status": "completed",
  "doc_url": "https://invoice-staging.paymeservice.com/documents/fa397fce-aee6-4c6d-ae9c-273ae1e3a317"
}

400 — Bad request. See the error table. (error)

{
  "status_code": 1,
  "status_error_details": "Document you're requested not ready yet",
  "status_additional_info": "status:waiting",
  "status_error_code": 1005,
  "session": "FhT3aXe7"
}

403 — The invoicing service isn't active for this seller (703). (error)

{
  "status_code": 1,
  "status_error_details": "Action is not permitted",
  "status_additional_info": "Invoicing Service was not properly activated. Operation not permitted",
  "status_error_code": 703,
  "session": "FhT3aXe7"
}

500 — Credentials or the invoicing service failed. See the error table. (error)

{
  "status_code": 1,
  "status_error_details": "Document not found",
  "status_additional_info": null,
  "status_error_code": 1003,
  "session": "FhT3aXe7"
}