{"openapi":"3.1.0","info":{"title":"Payments","version":"1.0.0","description":"API reference for accepting payments with PayMe — sales via hosted payment page, hosted fields or direct API, tokens, subscriptions, refunds and captures, 3D Secure, invoices and point-of-sale. Start with Getting Started for credentials, environments and a first sale."},"servers":[{"url":"https://sandbox.payme.io/api","description":"Sandbox"},{"url":"https://live.payme.io/api","description":"Production"}],"components":{"securitySchemes":{"merchantKey":{"type":"apiKey","in":"header","name":"PayMe-Merchant-Key"},"partnerKey":{"type":"apiKey","in":"header","name":"PayMe-Partner-Key"},"publicKey":{"type":"apiKey","in":"header","name":"PayMe-Public-Key"},"signature":{"type":"apiKey","in":"header","name":"PayMe-Signature"}}},"tags":[{"name":"Point of Sale (POS)"}],"paths":{"/vas-enable":{"post":{"operationId":"post-vas-enable","summary":"Order POS devices","tags":["Point of Sale (POS)"],"description":"## Overview\n\nPartners only. Orders POS devices for a seller by enabling the POS services with `vas-enable`. The process is manual: PayMe requests a new terminal (up to 5 business days), prepares the devices and ships them. PayMe pairs each device and sends you a `point-of-sale-action-pair-update` callback with its `pos_id`.\n\nDepending on how the service is set up, PayMe either opens a support ticket for the order (response `status_code` `2`, `Zendesk ticket created`) or enables the service at once and returns its details.\n\n### Step 1: enable the POS payment method\n\nCall `vas-enable` with the `vas_payme_id` of the POS payment method service.\n\n```json\n{\n  \"payme_client_key\": \"<your partner key>\",\n  \"seller_payme_id\": \"MPLDEMO-MPLDEMO-MPLDEMO-1234567\",\n  \"vas_payme_id\": \"VASL1545-8192915E-8192915E-8192915E\"\n}\n```\n\n### Step 2: order the devices\n\nCall `vas-enable` with the `vas_payme_id` of the POS device service and the device list in `vas_data`.\n\n```json\n{\n  \"payme_client_key\": \"<your partner key>\",\n  \"seller_payme_id\": \"MPLDEMO-MPLDEMO-MPLDEMO-1234567\",\n  \"vas_payme_id\": \"VASL1545-8192915E-5NTSEUM1-03YNFWNU\",\n  \"vas_data\": {\n    \"number_of_devices\": 2,\n    \"items\": [\n      {\n        \"pos_id\": \"001\",\n        \"shipping_address\": \"1 Example St, Tel Aviv\",\n        \"name\": \"Front counter\"\n      },\n      {\n        \"pos_id\": \"002\",\n        \"shipping_address\": \"1 Example St, Tel Aviv\",\n        \"name\": \"Back counter\"\n      }\n    ]\n  }\n}\n```\n\n### Adding devices later\n\nCall step 2 again with only the new devices and `vas_data.extend_items` `true`. Without `extend_items`, the list you send replaces the devices already stored.\n\n```json\n{\n  \"payme_client_key\": \"<your partner key>\",\n  \"seller_payme_id\": \"MPLDEMO-MPLDEMO-MPLDEMO-1234567\",\n  \"vas_payme_id\": \"VASL1545-8192915E-5NTSEUM1-03YNFWNU\",\n  \"vas_data\": {\n    \"extend_items\": true,\n    \"number_of_devices\": 1,\n    \"items\": [\n      {\n        \"pos_id\": \"003\",\n        \"shipping_address\": \"1 Example St, Tel Aviv\",\n        \"name\": \"Terrace\"\n      }\n    ]\n  }\n}\n```\n\n## Errors\n\nErrors return `status_code` `1`.\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | `payme_client_key`, `seller_payme_id` or `vas_payme_id` is missing. |\n| 400 | `703` | Your partner account has no permission for this service (`Partner has no permission for this VAS`). |\n| 500 | `720` | No service has this `vas_payme_id`. |\n| 500 | `200` | The partner key is unknown. |\n| 500 | `251` | The seller key is unknown. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"vas_payme_id":{"type":"string","description":"The service to enable: the POS payment method service (step 1) or the POS device service (step 2)."},"vas_payer_type":{"type":"integer","description":"Who pays the service fees: `1` partner, `2` seller, `3` reseller. Used only when the service is first created for the seller. Default: the payer set on your partner's service."},"vas_data":{"type":"object","description":"The device order. Send it in step 2.","properties":{"number_of_devices":{"type":"integer","description":"Number of devices ordered. It must equal the number of `items`."},"items":{"type":"array","description":"One entry per device.","items":{"type":"object","properties":{"pos_id":{"type":"string","description":"The device's POS ID. Payment requests address the device by this ID (`payment.pos_id`)."},"shipping_address":{"type":"string","description":"Where to ship the device."},"name":{"type":"string","description":"A name for the device, used during setup."}},"required":["pos_id","shipping_address","name"]}},"extend_items":{"type":"boolean","description":"`true` adds `items` to the devices already ordered for this seller. Default: the list you send replaces them."}},"required":["number_of_devices","items"]}},"required":["payme_client_key","seller_payme_id","vas_payme_id"]},"example":{"payme_client_key":"<your partner key>","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","vas_payme_id":"VASL1545-8192915E-5NTSEUM1-03YNFWNU","vas_data":{"number_of_devices":2,"items":[{"pos_id":"001","shipping_address":"1 Example St, Tel Aviv","name":"Front counter"},{"pos_id":"002","shipping_address":"1 Example St, Tel Aviv","name":"Back counter"}]}}}}},"responses":{"200":{"description":"PayMe opened a ticket for the order (`status_code` `2`), or enabled the service (`status_code` `0`).","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`2` PayMe opened a support ticket for the order. `0` the service was enabled; the service fields below are returned."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"message":{"type":"string","description":"`Zendesk ticket created`, when `status_code` is `2`."},"vas_payme_id":{"type":"string","description":"The `vas_payme_id` you sent, when `status_code` is `0`."},"vas_guid":{"type":"string","description":"ID of the seller's service, when `status_code` is `0`."},"vas_is_active":{"type":"boolean","description":"`true` if the seller's service is active."},"vas_type":{"type":"string","description":"Service type."},"vas_description":{"type":"string","description":"Service description."},"vas_payer_type":{"type":"integer","description":"Who pays the service fees: `1` partner, `2` seller, `3` reseller."},"vas_data":{"type":"object","description":"The stored device list, without hidden fields."}}},"example":{"status_code":2,"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","message":"Zendesk ticket created"}}}},"500":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Seller was not found","status_additional_info":"seller_payme_id","status_error_code":251,"session":"FhT3aXe7"}}}}}}},"/sales":{"post":{"operationId":"post-payment","summary":"Create a POS payment","tags":["Point of Sale (POS)"],"description":"## Overview\n\nCreates 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](/payments/point-of-sale-pos/put-sales).\n\nA 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:\n\n```json\n{\n  \"status_code\": 1,\n  \"payme_status\": \"error\",\n  \"status_error_code\": 20003,\n  \"status_error_details\": \"Transaction declined\",\n  \"payme_sale_id\": \"SALE1700-000000AA-EXAMPLE1-SALE0001\",\n  \"payme_sale_status\": \"failed\"\n}\n```\n\n- The seller must have an active POS service (error `720`), and the device must be paired and active.\n- `sale_type` `sale` (default) charges the card; `authorize` only authorizes it. `token` returns error `357`.\n- This call takes the same sale fields as [generate-sale](/payments/hosted-payment-page/post-generate-sale), for example `installments`.\n- Setup, pairing and the two-step flow: [POS module overview](/payments/point-of-sale-pos).\n\n## Authentication\n\nSend `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.\n\n## Errors\n\n| HTTP | Code | When |\n|---|---|---|\n| 200 | Decline code | The payment was declined or canceled on the device. `status_code` is `1`. |\n| 500 | `1` | A required field is missing, for example `seller_payme_id` or `currency`. `status_additional_info` names it. |\n| 400 | `357` | `sale_type` `token` isn't supported here. |\n| 400 | `720` | The POS service isn't active for this seller. |\n| 400 | `26014` | `payment.pos_id` is missing, or the seller has no device with this ID. |\n| 400 | `26017` | The device has no POS record. |\n| 400 | `26018` | The device isn't active. |\n| 500 | `251` | The seller key is unknown. |","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead."},"sale_price":{"type":"integer","description":"Amount in minor units (`10000` = 100.00)."},"currency":{"type":"string","description":"ISO 4217 currency code, for example `ILS`."},"product_name":{"type":"string","description":"What the buyer is paying for."},"payment":{"type":"object","description":"Where to send the payment.","properties":{"method":{"type":"string","description":"`pos`."},"pos_id":{"type":"string","description":"The device's ID, from the seller's POS service. The `point-of-sale-action-pair-update` callback also returns it."}},"required":["method","pos_id"]},"sale_type":{"type":"string","description":"`sale` (default) charges the card. `authorize` only authorizes it. `token` returns error `357`."},"installments":{"type":"integer","description":"Number of installments."},"transaction_id":{"type":"string","description":"Your own reference for the sale."},"sale_callback_url":{"type":"string","description":"URL for sale callbacks. Default: your partner's default callback URL, if one is set."},"customer":{"type":"object","description":"Buyer details. Every field is optional.","properties":{"name":{"type":"string","description":"Buyer's name."},"email":{"type":"string","description":"Buyer's email."},"phone":{"type":"string","description":"Buyer's mobile number."},"social_id":{"type":"string","description":"Buyer's national ID."},"zip_code":{"type":"string","description":"Zip code."},"country":{"type":"string","description":"Two-letter ISO country code."},"state":{"type":"string","description":"State or region."},"city":{"type":"string","description":"City."},"line1":{"type":"string","description":"Address line 1."},"line2":{"type":"string","description":"Address line 2."},"business_name":{"type":"string","description":"The buyer's business name. Send it together with `business_code`."},"business_code":{"type":"string","description":"The buyer's business registration number."}}},"language":{"type":"string","description":"Language of messages: `he` (default), `en`, `es`, `ru` or `ar`."}},"required":["seller_payme_id","sale_price","currency","product_name","payment"]},"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"}}}},"responses":{"200":{"description":"The device returned a result: paid (`status_code` `0`) or declined (`status_code` `1`).","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` paid. `1` declined or canceled (still HTTP 200)."},"payme_status":{"type":"string","description":"`success`, or `error` when the payment failed."},"status_error_code":{"type":"integer","description":"`0` on success; otherwise the decline code."},"status_error_details":{"type":"string","description":"Why the payment failed, when `status_code` is `1`."},"payme_sale_id":{"type":"string","description":"PayMe's sale ID. Use it to refund."},"payme_sale_code":{"type":"integer","description":"PayMe's numeric sale ID."},"sale_created":{"type":"string","description":"When the sale was created."},"payme_sale_status":{"type":"string","description":"Sale status, for example `completed`. See [Sale statuses](/payments/codes-statuses/sale-statuses)."},"sale_status":{"type":"string","description":"Same as `payme_sale_status`."},"currency":{"type":"string","description":"ISO 4217 currency code."},"transaction_id":{"type":"string","description":"Your reference, as sent."},"is_token_sale":{"type":"boolean","description":"`true` if the sale was paid with a saved token."},"price":{"type":"integer","description":"Sale amount in minor units."},"payme_signature":{"type":"string","description":"Signature of the sale. See [Callbacks](/payments/getting-started/callbacks)."},"sale_description":{"type":"string","description":"The `product_name` you sent."},"sale_deferred_months":{"type":"integer","description":"Deferred months, or `null`."},"payme_transaction_id":{"type":"string","description":"PayMe's transaction ID."},"payme_transaction_total":{"type":"string","description":"Amount charged, in minor units."},"payme_transaction_card_brand":{"type":"string","description":"Card brand."},"payme_transaction_auth_number":{"type":"string","description":"Authorization number."},"payme_transaction_voucher":{"type":"string","description":"Voucher number, or `null`."},"payme_transaction_emv_uid":{"type":"string","description":"EMV transaction ID from the device."},"payme_transaction_acquirer":{"type":"string","description":"The acquirer."},"payme_transaction_auth_source":{"type":"string","description":"Who authorized the transaction, for example `CreditCompany`."},"payme_transaction_card_issuer":{"type":"string","description":"The card issuer."},"payme_transaction_credit_type":{"type":"string","description":"Credit type, for example `RegularCredit`."},"buyer_name":{"type":"string","description":"Buyer's name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_card_mask":{"type":"string","description":"Masked card number."},"buyer_card_exp":{"type":"string","description":"Card expiry, `MMYY`."},"buyer_card_is_foreign":{"type":"boolean","description":"`true` if the card was issued outside the seller's country."},"buyer_social_id":{"type":"string","description":"Buyer's national ID, or `null`."},"installments":{"type":"integer","description":"Number of installments."},"transaction_first_payment":{"type":"string","description":"First installment amount, in minor units."},"transaction_periodical_payment":{"type":"integer","description":"Amount of each later installment, in minor units. `0` for a single payment."},"transaction_arn":{"type":"string","description":"Acquirer reference number (ARN)."},"sale_paid_date":{"type":"string","description":"When the sale was paid."},"sale_release_date":{"type":"string","description":"When the funds are released to the seller, or `null`."},"sale_3ds":{"type":"boolean","description":"`true` if 3D Secure was used."},"redirect_url":{"type":"string","description":"The sale's return URL, or `null`."}}},"example":{"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":{"description":"The device or the POS service can't take the payment. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Desired device is inactive","status_additional_info":null,"status_error_code":26018,"session":"FhT3aXe7"}}}},"500":{"description":"The request was refused. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"currency","status_error_code":1,"session":"FhT3aXe7"}}}}}}},"/sales/{sale_guid}":{"put":{"operationId":"put-sales","summary":"Refund a POS sale","tags":["Point of Sale (POS)"],"description":"## Overview\n\nRefunds a sale paid on a POS device. PayMe sends the refund to the device in `payment.pos_id` and returns the result in the same response.\n\nExample: `PUT https://sandbox.payme.io/api/sales/SALE1700-000000AA-EXAMPLE1-SALE0001`.\n\n- Send `payment.action` `refund`. Without it, this endpoint pays the sale instead of refunding it (see [POS module overview](/payments/point-of-sale-pos)).\n- Leave out `payment.amount` to refund everything that can still be refunded, or send a smaller amount for a partial refund.\n- `payment.verify_only` `true` runs the checks and returns without refunding.\n- `refunded_from_creditcard` is `true` when the seller's balance didn't cover the refund and PayMe charged the seller's card on file for the difference.\n\n## Authentication\n\nSend `seller_payme_id` (the seller's MPL) in the JSON body. The sale must belong to this seller. Partners also send `payme_client_key`, in the body or the `PayMe-Partner-Key` header.\n\n## Errors\n\n| HTTP | Code | When |\n|---|---|---|\n| 500 | `1` | A required field is missing: `seller_payme_id`, `payment` or `payment.method`. |\n| 500 | `350` | No sale has this ID. |\n| 500 | `4` | `payment.method` isn't the sale's payment method (`pos`). |\n| 400 | `720` | The POS service isn't active for this seller. |\n| 400 | `26014` | `payment.pos_id` is missing, or the seller has no device with this ID. |\n| 400 | `26017` | The device has no POS record. |\n| 400 | `26018` | The device isn't active. |\n| 500 | Decline code | The device or the card company declined the refund. |\n\n","parameters":[{"name":"sale_guid","in":"path","required":true,"description":"The sale's `payme_sale_id`. ","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. The sale must belong to this seller."},"payme_client_key":{"type":"string","description":"Partners only: your partner key. You can send it in the `PayMe-Partner-Key` header instead."},"payment":{"type":"object","description":"The refund to send to the device.","properties":{"method":{"type":"string","description":"`pos`. It must match the sale's payment method."},"action":{"type":"string","description":"`refund`. Without it, the call pays the sale instead of refunding it."},"pos_id":{"type":"string","description":"The device that processes the refund."},"amount":{"type":"integer","description":"Amount to refund, in minor units. Default: everything that can still be refunded. "},"verify_only":{"type":"boolean","description":"`true` runs the checks without refunding. "}},"required":["method","action","pos_id"]},"language":{"type":"string","description":"Language of messages: `he` (default), `en`, `es`, `ru` or `ar`."}},"required":["seller_payme_id","payment"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","payment":{"method":"pos","action":"refund","pos_id":"001"},"language":"en"}}}},"responses":{"200":{"description":"The refund was processed.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"payme_status":{"type":"string","description":"`success`."},"payme_sale_id":{"type":"string","description":"PayMe's sale ID."},"payme_sale_code":{"type":"integer","description":"PayMe's numeric sale ID."},"payme_sale_status":{"type":"string","description":"`refunded`, or `partial-refund` after a partial refund."},"sale_status":{"type":"string","description":"Same as `payme_sale_status`."},"currency":{"type":"string","description":"ISO 4217 currency code."},"price":{"type":"integer","description":"The original sale amount, in minor units."},"transaction_id":{"type":"string","description":"Your reference for the sale."},"sale_refund_buffer":{"type":"integer","description":"Amount that can still be refunded, in minor units."},"payme_transaction_id":{"type":"string","description":"ID of the refund transaction."},"payme_transaction_total":{"type":"integer","description":"Amount refunded, in minor units."},"payme_transaction_card_brand":{"type":"string","description":"Card brand."},"payme_transaction_auth_number":{"type":"string","description":"Authorization number of the refund."},"payme_signature":{"type":"string","description":"Signature of the refund. See [Callbacks](/payments/getting-started/callbacks)."},"refunded_from_creditcard":{"type":"boolean","description":"`true` if PayMe charged the seller's card on file because the balance didn't cover the refund."},"sale_invoice_number":{"type":"string","description":"Number of the credit document, if the invoicing service issued one. Otherwise `null`."},"sale_invoice_url":{"type":"string","description":"Link to the credit document, if one was issued. Otherwise `null`."}}},"example":{"status_code":0,"payme_status":"success","payme_sale_id":"SALE1700-000000AA-EXAMPLE1-SALE0001","payme_sale_code":12346578,"payme_sale_status":"refunded","sale_status":"refunded","currency":"ILS","price":10000,"transaction_id":"order-1001","sale_refund_buffer":0,"payme_transaction_id":"TRAN1700-000000AA-EXAMPLE1-TRAN0002","payme_transaction_total":10000,"payme_transaction_card_brand":"Mastercard","payme_transaction_auth_number":"0123456","payme_signature":"db1c276**********c5b39","refunded_from_creditcard":false,"sale_invoice_number":null,"sale_invoice_url":null}}}},"400":{"description":"The device or the POS service can't take the refund. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Desired device is inactive","status_additional_info":null,"status_error_code":26018,"session":"FhT3aXe7"}}}},"500":{"description":"The request was refused or the refund was declined. See the error table.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_details":{"type":"string","description":"What went wrong, in the language you asked for (Hebrew by default)."},"status_additional_info":{"type":"string","description":"The field or value concerned. Can be `null`."},"status_error_code":{"type":"integer","description":"PayMe error code. See the error table above and [Errors](/payments/getting-started/errors)."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Sale was not found","status_additional_info":"SALE1700-000000AA-EXAMPLE1-SALE0001","status_error_code":350,"session":"FhT3aXe7"}}}}}}}}}