{"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":"Query APIs"}],"paths":{"/get-sales":{"post":{"operationId":"post-get-sales","summary":"List sales","tags":["Query APIs"],"description":"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](/payments/query-apis/post-get-transactions): a refund or chargeback is its own transaction row.\n\nA 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.\n\nDefaults: 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.\n\nFilters 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`.\n\nTimestamps 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. \n\nResults 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](/payments/query-apis).","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Partner key. Partners only. Can also be sent in the `PayMe-Partner-Key` header. Without `seller_payme_id`, the query covers all your sellers."},"seller_payme_id":{"type":"string","description":"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."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent to create-seller. Partners only."},"sale_payme_code":{"type":"integer","description":"PayMe's numeric sale code."},"sale_payme_id":{"type":"string","description":"PayMe's sale ID, as returned by generate-sale."},"transaction_id":{"type":"string","description":"Your own order ID, as sent to generate-sale. It is not unique, so the call can return several sales."},"sale_type":{"type":"integer","description":"Numeric sale type, see [Sale Types](/payments/codes-statuses/sale-types). Default `[1, 3, 4, 5, 7, 10, 11]`."},"sale_parent_code":{"type":"integer","description":"Code of the parent the sale was created from, for example the template's `sale_payme_code`."},"sale_created":{"type":"string","description":"Exact creation date and time, `yyyy-mm-dd hh:mm:ss`."},"sale_created_min":{"type":"string","description":"Created at or after this time, `yyyy-mm-dd hh:mm:ss`."},"sale_created_max":{"type":"string","description":"Created at or before this time, `yyyy-mm-dd hh:mm:ss`."},"sale_status":{"type":"string","description":"Sale status name, or an array of them, for example `[\"completed\", \"refunded\"]`. See [Sale Statuses](/payments/codes-statuses/sale-statuses). Default: every status except `initial`."},"sale_price":{"type":"integer","description":"Exact amount, in minor units (`5075` = 50.75)."},"sale_currency":{"type":"string","description":"Currency, 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code, for example `ILS`."},"sale_payment_method":{"type":"string","description":"Payment method, for example `credit-card`, `bit`, `apple-pay` or `google-pay`. See [Wallets & APMs](/payments/wallets-apms)."},"sale_auth_number":{"type":"string","description":"Authorization number from the card company."},"sale_is_3ds":{"type":"boolean","description":"`true` returns only sales paid with 3D Secure, `false` only sales paid without it."},"sale_send_notification":{"type":"boolean","description":"`true` returns only `initial` or `failed` sales that have a buyer email or phone, for example to send a payment reminder."},"buyer_card_mask":{"type":"string","description":"Masked card number, first 6 and last 4 digits, for example `458045******4580`."},"buyer_card_last_four_digits":{"type":"string","description":"Last four digits of the card."},"buyer_card_is_foreign":{"type":"boolean","description":"`true` returns only sales paid with a foreign card, `false` only local cards."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number (Israeli sellers)."},"page":{"type":"integer","description":"Page number, `1`–`1000`. Default `1`. Out of range returns error `52`."},"page_size":{"type":"integer","description":"Items per page, `1`–`500`. Default `500`. Out of range returns error `27`."},"items_order_by_column":{"type":"string","description":"Field to sort by, for example `sale_created`. Without it, the order isn't guaranteed. A field that doesn't exist fails the call."},"items_order_by_direction":{"type":"string","description":"`asc` (default) or `desc`, in upper or lower case. Used only with `items_order_by_column`. Any other value returns error `28`."}}},"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}}},"description":"Every field is optional. Send at least your credentials."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"items_count":{"type":"integer","description":"Number of items on this page. There is no total count."},"items":{"type":"array","description":"The sales.","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"Your own ID for the seller, or `null`."},"sale_payme_id":{"type":"string","description":"PayMe's sale ID."},"sale_payme_code":{"type":"integer","description":"PayMe's numeric sale code."},"transaction_id":{"type":"string","description":"Your own order ID, as you sent it to generate-sale. It is not unique: several sales can share it."},"sale_type":{"type":"integer","description":"Numeric sale type, see [Sale Types](/payments/codes-statuses/sale-types)."},"sale_payment_method":{"type":"string","description":"Payment method of the sale, for example `credit-card`."},"sale_created":{"type":"string","description":"Creation time, `yyyy-mm-dd hh:mm:ss`."},"sale_status":{"type":"string","description":"Sale status, see [Sale Statuses](/payments/codes-statuses/sale-statuses)."},"sale_currency":{"type":"string","description":"Currency, 3-letter ISO 4217 code."},"sale_price":{"type":"integer","description":"Amount charged, in minor units (`5075` = 50.75). The sale price when there is no payment yet."},"sale_price_after_fees":{"type":"string","description":"Net amount after PayMe fees, in minor units, as a numeric string. Final once the transaction is settled. `null` without a payment."},"sale_description":{"type":"string","description":"What the buyer paid for."},"sale_installments":{"type":"integer","description":"Number of installments. `null` if the sale has no payment yet."},"transaction_first_payment":{"type":"string","description":"First installment, in minor units, or the full amount when there are no installments."},"transaction_periodical_payment":{"type":"string","description":"Each later installment, in minor units. `0` when there are no installments."},"transaction_risk_score":{"type":"integer","description":"Fraud risk score of the payment, or `null` without a payment."},"sale_vat":{"type":"string","description":"VAT rate at the time of the sale, as a fraction (`\"0.18\"` = 18%)."},"sale_paid_date":{"type":"string","description":"When the payment was made, `yyyy-mm-dd hh:mm:ss`. `null` if not paid."},"sale_auth_number":{"type":"string","description":"Authorization number from the card company."},"sale_release_date":{"type":"string","description":"When the funds are expected in the seller's balance, `yyyy-mm-dd hh:mm:ss`, or `null`."},"sale_error_code":{"type":"string","description":"Error code of a failed payment, otherwise `null`."},"sale_error_text":{"type":"string","description":"Gateway message for the payment. On a failed payment, the error message."},"sale_url":{"type":"string","description":"Link to the sale's payment page."},"sale_is_3ds":{"type":"boolean","description":"`true` if the payment used 3D Secure."},"sale_fees":{"type":"object","description":"Fees on this sale. Rates are percent strings. `*_total` fields are in minor units, without VAT, computed on `sale_price`.","properties":{"sale_processing_fee":{"type":"string","description":"Processing rate, percent of the amount (`\"2.50\"` = 2.5%)."},"sale_processing_fee_total":{"type":"integer","description":"Processing fee, in minor units."},"sale_processing_charge":{"type":"string","description":"Fixed processing charge per sale, in major units (`\"1.20\"` = 1.20)."},"sale_discount_fee":{"type":"string","description":"Discount rate (early settlement of installments) per installment, percent."},"sale_discount_fee_total":{"type":"integer","description":"Discount fee, in minor units."},"sale_rapid_settlement_fee":{"type":"string","description":"Rapid settlement rate, percent."},"sale_rapid_settlement_fee_total":{"type":"integer","description":"Rapid settlement fee, in minor units."},"sale_annual_interest_rate":{"type":"string","description":"Annual interest rate (percent) behind the discount and rapid settlement fees, or `null`."},"sale_market_fee":{"type":"string","description":"Platform (market) fee rate, percent of the amount."},"sale_market_fee_fixed":{"type":"number","description":"Fixed platform fee per sale, in major units."},"sale_market_fee_total":{"type":"integer","description":"Platform fee, in minor units: the percent part plus the fixed part."}}},"sale_buyer_details":{"type":"object","description":"The buyer and the card used.","properties":{"buyer_card_mask":{"type":"string","description":"Masked card number: first 6 and last 4 digits."},"buyer_card_expiry":{"type":"string","description":"Card expiry, `MMYY`."},"buyer_card_brand":{"type":"string","description":"Card brand, for example `Visa`."},"buyer_card_is_foreign":{"type":"boolean","description":"`true` for a card issued outside the seller's country, `false` for a local card."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number."}}},"sale_invoices":{"type":"object","description":"Invoices for the sale, keyed by invoice document number. Each value has `invoice_doc_number` and `invoice_url`. `{}` when there are none."}}}}}},"example":{"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":{"description":"Error. Most errors return HTTP 500. Paging errors (`52`, `27`) return HTTP 400. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}},"/get-transactions":{"post":{"operationId":"post-get-transactions","summary":"List transactions","tags":["Query APIs"],"description":"Returns money movements (payments, captures, refunds, voids and chargebacks) for one seller or all your sellers. Use it for amounts in a period: a refund or chargeback is its own row, with its own date and a positive `transaction_price`.\n\nA 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.\n\n#### Defaults\n- `transaction_type` is `1` (sale transactions). A sale that is authorized and not yet captured is type `40`, so send `transaction_type: 40` to see it. Types are listed on [Transaction Types](/payments/codes-statuses/transaction-types).\n- The default statuses are `validated`, `failed`, `refunded`, `p-refund`, `chargeback`, `partial-chargeback`, `chargeback-refund` and `partial-chargeback-refund`. `pending`, `voided` and `partial-void` rows are left out. Send `transaction_status: \"validated\"` when you add up volume. Statuses are listed on [Transaction Statuses](/payments/codes-statuses/transaction-statuses).\n- A voided authorization returns no rows from a default query: with `transaction_type: 40` you get its authorization row, whose `sale_status` is `voided`, and adding `transaction_status: [\"validated\", \"voided\"]` also returns the `Void` row.\n\n#### Telling rows apart\n`transaction_action` says what each row is: `Debit`, `Authorize`, `Capture`, `Refund`, `Partial Refund`, `Void`, `Partial Void`, `Chargeback`, `Partial Chargeback`, `Chargeback Refund`, `Partial Chargeback Refund`, `Tokenize` or `Detokenize`. A refund is its own row, with a positive `transaction_price`, the action `Refund` or `Partial Refund`, and the status `refunded` or `p-refund`. A void adds no refund row. See [Reading the rows](/agents/steps/capture-refund-void#reading-the-rows). \n\nFor a sale opened with `sale_payment_method` `multi`, `transaction_payment_method` shows the method the buyer actually used; the sale keeps `multi`. `transaction_error_code` is `null` on a successful transaction.\n\nThis call is rate limited per partner, or per seller when there's no partner key. On HTTP 429 (error `998`), wait for the `Retry-After` time and retry.\n\nTimestamps 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. \n\nResults 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](/payments/query-apis).","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Partner key. Partners only. Can also be sent in the `PayMe-Partner-Key` header. Without `seller_payme_id`, the query covers all your sellers."},"seller_payme_id":{"type":"string","description":"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."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent to create-seller. Partners only."},"sale_payme_id":{"type":"string","description":"PayMe's sale ID."},"sale_payme_code":{"type":"integer","description":"PayMe's numeric sale code."},"transaction_id":{"type":"string","description":"Your own order ID, as sent to generate-sale. It is not unique."},"payme_transaction_id":{"type":"string","description":"PayMe's transaction ID."},"transaction_type":{"type":"integer","description":"Transaction type, or an array of them. See [Transaction Types](/payments/codes-statuses/transaction-types). Default `1`."},"transaction_status":{"type":"string","description":"Transaction status name, or an array of up to 100. See [Transaction Statuses](/payments/codes-statuses/transaction-statuses). The default set is in the description above."},"sale_status":{"type":"string","description":"Status of the transaction's sale, for example `completed`, or an array of up to 100. See [Sale Statuses](/payments/codes-statuses/sale-statuses)."},"sale_currency":{"type":"string","description":"Currency, 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code, for example `ILS`, or an array of up to 100."},"sale_payment_method":{"type":"string","description":"Payment method of the sale, for example `credit-card`, or an array of up to 100. See [Wallets & APMs](/payments/wallets-apms)."},"transaction_payment_method":{"type":"string","description":"Payment method actually used on the transaction, for example `bit` on a `multi` sale."},"transaction_created":{"type":"string","description":"Exact creation date and time, `yyyy-mm-dd hh:mm:ss`."},"transaction_created_min":{"type":"string","description":"Created at or after this time, `yyyy-mm-dd hh:mm:ss`."},"transaction_created_max":{"type":"string","description":"Created at or before this time, `yyyy-mm-dd hh:mm:ss`."},"transaction_price":{"type":"integer","description":"Exact transaction amount, in minor units (`5075` = 50.75)."},"sale_price":{"type":"integer","description":"Exact sale amount, in minor units."},"sale_auth_number":{"type":"string","description":"Authorization number from the card company."},"buyer_card_mask":{"type":"string","description":"Masked card number, first 6 and last 4 digits."},"buyer_card_last_four_digits":{"type":"string","description":"Last four digits of the card."},"buyer_card_is_foreign":{"type":"boolean","description":"`true` returns only foreign cards, `false` only local cards."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number."},"sale_is_3ds":{"type":"boolean","description":"`true` returns only transactions paid with 3D Secure, `false` only those without it."},"transaction_is_matched":{"type":"boolean","description":"`true` returns only transactions that PayMe has matched (correlated) in its reconciliation, `false` only the others."},"page":{"type":"integer","description":"Page number, `1`–`1000`. Default `1`. Out of range returns error `52`."},"page_size":{"type":"integer","description":"Items per page, `1`–`500`. Default `500`. Out of range returns error `27`."},"items_order_by_column":{"type":"string","description":"Field to sort by, for example `transaction_created_at`. Without it, the order isn't guaranteed. A field that doesn't exist fails the call."},"items_order_by_direction":{"type":"string","description":"`asc` (default) or `desc`, in upper or lower case. Used only with `items_order_by_column`. Any other value returns error `28`."}}},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","transaction_status":"validated","transaction_created_min":"2026-10-01 00:00:00","transaction_created_max":"2026-10-31 23:59:59","sale_currency":"ILS","items_order_by_column":"transaction_created_at","page":1,"page_size":500}}},"description":"Every field is optional. Send at least your credentials."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"items_count":{"type":"integer","description":"Number of items on this page. There is no total count."},"items":{"type":"array","description":"The transactions.","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"Your own ID for the seller, or `null`."},"sale_payme_id":{"type":"string","description":"PayMe's sale ID."},"sale_payme_code":{"type":"integer","description":"PayMe's numeric sale code."},"transaction_id":{"type":"string","description":"Your own order ID, as you sent it to generate-sale. Not a PayMe ID, and not unique."},"payme_transaction_id":{"type":"string","description":"PayMe's transaction ID. Use it in `transaction_ids` on withdraw-balance."},"transaction_created_at":{"type":"string","description":"Creation time, `yyyy-mm-dd hh:mm:ss`, Asia/Jerusalem."},"sale_type":{"type":"integer","description":"Numeric sale type, see [Sale Types](/payments/codes-statuses/sale-types)."},"sale_status":{"type":"string","description":"Status of the sale, see [Sale Statuses](/payments/codes-statuses/sale-statuses)."},"transaction_status":{"type":"string","description":"Status of this row, see [Transaction Statuses](/payments/codes-statuses/transaction-statuses)."},"transaction_type":{"type":"integer","description":"Transaction type, see [Transaction Types](/payments/codes-statuses/transaction-types)."},"transaction_action":{"type":"string","description":"What this row is: `Authorize`, `Tokenize`, `Detokenize`, `Debit`, `Capture`, `Refund`, `Partial Refund`, `Void`, `Partial Void`, `Chargeback`, `Partial Chargeback`, `Chargeback Refund` or `Partial Chargeback Refund`."},"sale_currency":{"type":"string","description":"Currency, 3-letter ISO 4217 code."},"sale_description":{"type":"string","description":"What the buyer paid for."},"sale_installments":{"type":"integer","description":"Number of installments."},"sale_payment_method":{"type":"string","description":"Payment method of the sale, see [Wallets & APMs](/payments/wallets-apms)."},"transaction_payment_method":{"type":"string","description":"Payment method used on this transaction. For a `multi` sale, the method the buyer chose."},"transaction_price":{"type":"integer","description":"Amount of this row, in minor units. Positive for refunds and chargebacks too."},"transaction_price_after_fees":{"type":"string","description":"Net amount after PayMe fees, in minor units, as a numeric string. Final once settled."},"sale_vat":{"type":"string","description":"VAT rate at the time of the sale, as a fraction (`\"0.18\"` = 18%)."},"sale_auth_number":{"type":"string","description":"Authorization number from the card company."},"sale_is_3ds":{"type":"boolean","description":"`true` if the payment used 3D Secure."},"transaction_release_date":{"type":"string","description":"When the funds are expected in the seller's balance, `yyyy-mm-dd hh:mm:ss`, or `null`."},"transaction_voucher":{"type":"string","description":"Voucher number of the transaction."},"transaction_reference_number":{"type":"string","description":"Reference number from the gateway, or `null`."},"transaction_first_payment":{"type":"string","description":"First installment, in minor units, or the full amount when there are no installments."},"transaction_periodical_payment":{"type":"string","description":"Each later installment, in minor units. `0` when there are no installments."},"transaction_arn":{"type":"string","description":"Acquirer reference number (ARN), or `null`."},"transaction_acquirer":{"type":"string","description":"Acquirer that processed the transaction, or `null`."},"transaction_discounter":{"type":"string","description":"Company that settles the transaction, or `null`."},"transaction_credit_type":{"type":"string","description":"Credit type of the card transaction, as reported by the acquirer."},"transaction_error_code":{"type":"string","description":"Error code on failure. `null` on success."},"transaction_error_text":{"type":"string","description":"Gateway message for the transaction."},"transaction_comment":{"type":"string","description":"Chargeback reason. `null` except on chargeback rows."},"transaction_is_matched":{"type":"boolean","description":"`true` when PayMe has matched (correlated) the transaction in its reconciliation."},"transaction_match_statuses":{"type":"array","description":"The reconciliation statuses set on the transaction. Empty when it isn't matched."},"transaction_is_canceled":{"type":"boolean","description":"`true` if the transaction was canceled before it was transmitted."},"transaction_is_eligible_for_manual_auth":{"type":"boolean","description":"`true` when the transaction was processed by an Israeli acquirer."},"sale_fees":{"type":"object","description":"Fees on this row. Rates are percent strings. `*_total` fields are in minor units, without VAT, computed on `transaction_price`.","properties":{"sale_processing_fee":{"type":"string","description":"Processing rate, percent of the amount (`\"2.50\"` = 2.5%)."},"sale_processing_fee_total":{"type":"integer","description":"Processing fee, in minor units."},"sale_processing_charge":{"type":"string","description":"Fixed processing charge per sale, in major units (`\"1.20\"` = 1.20)."},"sale_discount_fee":{"type":"string","description":"Discount rate (early settlement of installments) per installment, percent."},"sale_discount_fee_total":{"type":"integer","description":"Discount fee, in minor units."},"sale_rapid_settlement_fee":{"type":"string","description":"Rapid settlement rate, percent."},"sale_rapid_settlement_fee_total":{"type":"integer","description":"Rapid settlement fee, in minor units."},"sale_annual_interest_rate":{"type":"string","description":"Annual interest rate (percent) behind the discount and rapid settlement fees, or `null`."},"sale_market_fee":{"type":"string","description":"Platform (market) fee rate, percent of the amount."},"sale_market_fee_fixed":{"type":"number","description":"Fixed platform fee per sale, in major units."},"sale_market_fee_total":{"type":"integer","description":"Platform fee, in minor units: the percent part plus the fixed part."}}},"sale_business_data":{"type":"object","description":"Only on `transaction_type` `50` rows: business details of the paying seller. On these rows `sale_fees` is `{}`."},"sale_buyer_details":{"type":"object","description":"The buyer and the card used.","properties":{"buyer_card_mask":{"type":"string","description":"Masked card number: first 6 and last 4 digits."},"buyer_card_expiry":{"type":"string","description":"Card expiry, `MMYY`."},"buyer_card_brand":{"type":"string","description":"Card brand, for example `Visa`."},"buyer_card_is_foreign":{"type":"boolean","description":"`true` for a card issued outside the seller's country, `false` for a local card."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number."}}},"transaction_invoice_url":{"type":"string","description":"Link to the transaction's invoice, or `null`."},"transaction_invoice_doc_number":{"type":"string","description":"Invoice document number, or `null`."}}}}}},"example":{"status_code":0,"items_count":1,"items":[{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_id":null,"sale_payme_id":"SALE1499-869577YG-Y2QXJ6PK-INXR2FAE","sale_payme_code":115498,"transaction_id":"order-12345","payme_transaction_id":"TRAN1499-869602B9-7QIUNKHI-F0SL1AOV","transaction_created_at":"2026-10-12 17:26:42","sale_type":1,"sale_status":"completed","transaction_status":"validated","transaction_type":1,"transaction_action":"Debit","sale_currency":"ILS","sale_description":"Handmade ceramic bowl","sale_installments":1,"sale_payment_method":"credit-card","transaction_payment_method":"credit-card","transaction_price":9000,"transaction_price_after_fees":"8617","sale_vat":"0.18","sale_auth_number":"2154577","sale_is_3ds":false,"transaction_release_date":"2026-10-19 06:00:00","transaction_voucher":"10784","transaction_reference_number":null,"transaction_first_payment":"9000","transaction_periodical_payment":"0","transaction_arn":null,"transaction_acquirer":null,"transaction_discounter":null,"transaction_credit_type":"1","transaction_error_code":null,"transaction_error_text":"Permitted transaction","transaction_comment":null,"transaction_is_matched":false,"transaction_match_statuses":[],"transaction_is_canceled":false,"transaction_is_eligible_for_manual_auth":false,"sale_fees":{"sale_processing_fee":"2.50","sale_processing_fee_total":225,"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":"0.00","sale_market_fee_fixed":0,"sale_market_fee_total":0},"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"},"transaction_invoice_url":null,"transaction_invoice_doc_number":null}]}}}},"500":{"description":"Error. Most errors return HTTP 500. Paging errors (`52`, `27`) return HTTP 400, and the rate limit (`998`) returns HTTP 429. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}},"/get-subscriptions":{"post":{"operationId":"post-get-subscriptions","summary":"List subscriptions","tags":["Query APIs"],"description":"Returns subscriptions for one seller or all your sellers, with their status, schedule and buyer. Use `sub_status` to find active (`2`) or failing (`4`, `7`) subscriptions. The response never contains the `buyer_key`. See [Recurring Payments](/payments/saved-cards-recurring) for how subscriptions are charged and retried.\n\nA 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.\n\nStatus values are numbers, see [Subscription Statuses](/payments/codes-statuses/subscription-statuses). Iteration types are on [Subscription Iteration Types](/payments/codes-statuses/subscription-iteration-types). Without `sub_type`, all four subscription types are returned.\n\nFilters are exact matches, except `sub_created_min` / `sub_created_max`. Most filters take a single value or an array of up to 100 values. Dates are `yyyy-mm-dd hh:mm:ss`.\n\nTimestamps and the `*_min` / `*_max` filters are Asia/Jerusalem local time, not UTC. \n\nResults 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](/payments/query-apis).","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Partner key. Partners only. Can also be sent in the `PayMe-Partner-Key` header. Without `seller_payme_id`, the query covers all your sellers."},"seller_payme_id":{"type":"string","description":"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."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent to create-seller. Partners only."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription code."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID."},"subscription_id":{"type":"string","description":"Your own reference set on generate-subscription. Not unique: several subscriptions can match."},"sub_parent_code":{"type":"integer","description":"Code of the parent the subscription was created from, such as its template."},"sub_type":{"type":"integer","description":"Subscription type, or an array of them: `1` regular, `2` created from a template, `10` template, `20` payment contract. Default: all four."},"sub_created":{"type":"string","description":"Exact creation date and time, `yyyy-mm-dd hh:mm:ss`."},"sub_created_min":{"type":"string","description":"Created at or after this time, `yyyy-mm-dd hh:mm:ss`."},"sub_created_max":{"type":"string","description":"Created at or before this time, `yyyy-mm-dd hh:mm:ss`."},"sub_status":{"type":"integer","description":"Subscription status, or an array of them: `1` initial, `2` active, `3` paused, `4` failed, `5` canceled, `6` completed, `7` failed, pending an automatic retry. See [Subscription Statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Iteration type, see [Subscription Iteration Types](/payments/codes-statuses/subscription-iteration-types)."},"sub_price":{"type":"integer","description":"Exact price, in minor units (`5075` = 50.75)."},"sub_currency":{"type":"string","description":"Subscription currency, 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code."},"sub_iterations":{"type":"integer","description":"Total number of charges. `-1` for a subscription with no end."},"sub_paid":{"type":"boolean","description":"`true` returns only subscriptions the buyer has paid (a payment method is saved), `false` only unpaid ones."},"sub_send_notification":{"type":"boolean","description":"`true` returns only `initial` subscriptions that have a buyer email or phone, for example to send a payment reminder."},"buyer_card_mask":{"type":"string","description":"Masked card number, first 6 and last 4 digits."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number."},"page":{"type":"integer","description":"Page number, `1`–`1000`. Default `1`. Out of range returns error `52`."},"page_size":{"type":"integer","description":"Items per page, `1`–`500`. Default `500`. Out of range returns error `27`."},"items_order_by_column":{"type":"string","description":"Field to sort by, for example `sub_created`. Without it, the order isn't guaranteed. A field that doesn't exist fails the call."},"items_order_by_direction":{"type":"string","description":"`asc` (default) or `desc`, in upper or lower case. Used only with `items_order_by_column`. Any other value returns error `28`."}}},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_status":[4,7]}}},"description":"Every field is optional. Send at least your credentials."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"items_count":{"type":"integer","description":"Number of items on this page. There is no total count."},"items":{"type":"array","description":"The subscriptions.","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"Your own ID for the seller, or `null`."},"sub_payme_id":{"type":"string","description":"PayMe's subscription ID."},"sub_payme_code":{"type":"integer","description":"PayMe's numeric subscription code."},"sub_parent_code":{"type":"integer","description":"Code of the parent the subscription was created from, or `null`."},"subscription_id":{"type":"string","description":"Your own reference, as sent to generate-subscription."},"sub_type":{"type":"integer","description":"Subscription type: `1` regular, `2` created from a template, `10` template, `20` payment contract."},"sub_created":{"type":"string","description":"Creation time, `yyyy-mm-dd hh:mm:ss`."},"sub_start_date":{"type":"string","description":"Start date of the subscription, `yyyy-mm-dd hh:mm:ss`."},"sub_prev_date":{"type":"string","description":"Date of the previous charge, `yyyy-mm-dd hh:mm:ss`, or `null`."},"sub_next_date":{"type":"string","description":"Date of the next charge, `yyyy-mm-dd hh:mm:ss`, or `null`."},"sub_status":{"type":"integer","description":"Subscription status: `1` initial, `2` active, `3` paused, `4` failed, `5` canceled, `6` completed, `7` failed, pending an automatic retry. See [Subscription Statuses](/payments/codes-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"integer","description":"Iteration type, see [Subscription Iteration Types](/payments/codes-statuses/subscription-iteration-types)."},"sub_currency":{"type":"string","description":"Subscription currency, 3-letter ISO 4217 code."},"sub_price":{"type":"integer","description":"Price of each charge, in minor units (`5075` = 50.75)."},"sub_description":{"type":"string","description":"Description of the subscription."},"sub_iterations":{"type":"integer","description":"Total number of charges. `-1` when the subscription has no end."},"sub_iterations_completed":{"type":"integer","description":"Charges completed so far."},"sub_iterations_skipped":{"type":"integer","description":"Charges skipped."},"sub_iterations_left":{"type":"integer","description":"Charges left."},"sub_payment_date":{"type":"string","description":"When the buyer's payment method was saved (the first successful payment), `yyyy-mm-dd hh:mm:ss`, or `null`."},"sub_error_text":{"type":"string","description":"Reason for the last failure, if any."},"sub_url":{"type":"string","description":"Link to the subscription's payment page."},"sub_paid":{"type":"boolean","description":"`true` once the buyer has paid and a payment method is saved."},"sub_buyer_details":{"type":"object","description":"The buyer.","properties":{"buyer_card_mask":{"type":"string","description":"Masked card number: first 6 and last 4 digits."},"buyer_name":{"type":"string","description":"Buyer's full name."},"buyer_email":{"type":"string","description":"Buyer's email."},"buyer_phone":{"type":"string","description":"Buyer's phone number."},"buyer_social_id":{"type":"string","description":"Buyer's national ID number."}}}}}}}},"example":{"status_code":0,"items_count":1,"items":[{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_id":"store-1001","sub_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","sub_payme_code":1234,"sub_parent_code":null,"subscription_id":"member-778","sub_type":1,"sub_created":"2026-01-01 15:15:15","sub_start_date":"2026-01-10 08:00:00","sub_prev_date":"2026-10-10 08:00:00","sub_next_date":"2026-11-10 08:00:00","sub_status":7,"sub_iteration_type":3,"sub_currency":"ILS","sub_price":10000,"sub_description":"Monthly membership","sub_iterations":12,"sub_iterations_completed":9,"sub_iterations_skipped":0,"sub_iterations_left":3,"sub_payment_date":"2026-01-10 08:00:05","sub_error_text":"Card declined","sub_url":"https://sandbox.payme.io/subscription/generate/XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","sub_paid":true,"sub_buyer_details":{"buyer_card_mask":"458045******4580","buyer_name":"Israel Israeli","buyer_email":"buyer@example.com","buyer_phone":"0500000001","buyer_social_id":"000000018"}}]}}}},"500":{"description":"Error. Most errors return HTTP 500. Paging errors (`52`, `27`) return HTTP 400. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}},"/get-sellers":{"post":{"operationId":"post-get-sellers","summary":"List sellers","tags":["Query APIs"],"description":"Returns your sellers with their personal, business and bank details, fee settings and wallet balances. Use it to check a seller's balance or approval, or to list the sellers created in a period. Only seller accounts are returned, not partner or system accounts.\n\nA 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. The response contains ID numbers and bank details: keep it on your server.\n\nSet `api_mode` to `slim` for a faster call on long lists. It leaves out `seller_wallets`, `seller_monthly_invoices` and `seller_monthly_balance_authorizations`. Omit `api_mode` for the default, which includes them.\n\nFilters are exact matches, except `seller_created_min` / `seller_created_max`. Most filters take a single value or an array of up to 100 values. Dates are `yyyy-mm-dd hh:mm:ss`, Asia/Jerusalem time.\n\nResults 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](/payments/query-apis).","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Partner key. Partners only. Can also be sent in the `PayMe-Partner-Key` header. Without `seller_payme_id`, the query covers all your sellers."},"seller_payme_id":{"type":"string","description":"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."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent to create-seller. Partners only."},"api_mode":{"type":"string","description":"`slim` returns seller details only, without `seller_wallets`, `seller_monthly_invoices` and `seller_monthly_balance_authorizations`. Omit it for the default, which includes them."},"seller_created":{"type":"string","description":"Exact creation date and time, `yyyy-mm-dd hh:mm:ss`."},"seller_created_min":{"type":"string","description":"Created at or after this time, `yyyy-mm-dd hh:mm:ss`."},"seller_created_max":{"type":"string","description":"Created at or before this time, `yyyy-mm-dd hh:mm:ss`."},"seller_first_name":{"type":"string","description":"First name of the seller's owner."},"seller_last_name":{"type":"string","description":"Last name of the seller's owner."},"seller_social_id":{"type":"string","description":"National ID number of the seller's owner."},"seller_email":{"type":"string","description":"Seller's email."},"seller_phone":{"type":"string","description":"Seller's phone number."},"seller_contact_email":{"type":"string","description":"Contact email shown to buyers."},"seller_contact_phone":{"type":"string","description":"Contact phone shown to buyers."},"seller_inc":{"type":"integer","description":"Incorporation type, see [Seller Incorporation Types (IL)](/marketplaces-and-platforms/seller-reference/seller-incorporation-types-il). `0` and `1` both mean Individual."},"seller_inc_code":{"type":"string","description":"Business registration number (ח.פ or ע.מ)."},"seller_merchant_name":{"type":"string","description":"Seller's business name."},"fee_market_fee":{"type":"number","description":"The seller's default platform (market) fee, percent of the sale price."},"seller_active":{"type":"boolean","description":"`true` returns only active sellers, `false` only inactive ones."},"seller_approved":{"type":"boolean","description":"`true` returns only sellers approved by PayMe, `false` only sellers not approved yet."},"page":{"type":"integer","description":"Page number, `1`–`1000`. Default `1`. Out of range returns error `52`."},"page_size":{"type":"integer","description":"Items per page, `1`–`500`. Default `500`. Out of range returns error `27`."},"items_order_by_column":{"type":"string","description":"Field to sort by. Without it, the order isn't guaranteed. A field that doesn't exist fails the call."},"items_order_by_direction":{"type":"string","description":"`asc` (default) or `desc`, in upper or lower case. Used only with `items_order_by_column`. Any other value returns error `28`."}}},"example":{"payme_client_key":"XXXXXXXX","seller_created_min":"2026-10-01 00:00:00","seller_created_max":"2026-10-31 23:59:59","seller_approved":true,"api_mode":"slim"}}},"description":"Every field is optional. Send at least your credentials."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"items_count":{"type":"integer","description":"Number of items on this page. There is no total count."},"items":{"type":"array","description":"The sellers.","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"Your own ID for the seller, or `null`."},"seller_created":{"type":"string","description":"Creation time, `yyyy-mm-dd hh:mm:ss`."},"seller_active":{"type":"boolean","description":"`true` if the seller is active."},"seller_approved":{"type":"boolean","description":"`true` once PayMe has approved the seller. Withdrawals need approval."},"seller_approved_date":{"type":"string","description":"When PayMe approved the seller, or `null`."},"seller_is_deferred":{"type":"boolean","description":"`true` if the seller's account type is Deferred."},"seller_withdrawal_plan":{"type":"integer","description":"Withdrawal plan: `1` manual, `2` daily, `3` monthly."},"seller_withdrawal_date":{"type":"integer","description":"Day of the month of the payout when the plan is `3`, otherwise `null`."},"seller_allow_foreign_cards":{"type":"boolean","description":"`true` if the seller accepts foreign cards."},"seller_personal_details":{"type":"object","description":"The seller's owner (primary individual).","properties":{"seller_first_name":{"type":"string","description":"First name."},"seller_last_name":{"type":"string","description":"Last name."},"seller_first_name_en":{"type":"string","description":"First name in English."},"seller_last_name_en":{"type":"string","description":"Last name in English."},"seller_social_id":{"type":"string","description":"National ID number."},"seller_social_id_country":{"type":"string","description":"Country that issued the ID, ISO 3166-1 alpha-2 code."},"seller_social_id_issued":{"type":"string","description":"ID issue date, `yyyy-mm-dd`."},"seller_birthdate":{"type":"string","description":"Date of birth, `yyyy-mm-dd`."},"seller_date_of_birth":{"type":"string","description":"Same as `seller_birthdate`. Kept for older integrations."},"seller_gender":{"type":"integer","description":"`0` male, `1` female, `2` other."},"seller_email":{"type":"string","description":"Seller's email."},"seller_phone":{"type":"string","description":"Seller's phone number."},"seller_has_criminal_record":{"type":"boolean","description":"The owner's answer to the criminal record question, or `null`."}}},"seller_business_details":{"type":"object","description":"The business and its bank account.","properties":{"seller_inc":{"type":"integer","description":"Incorporation type, see [Seller Incorporation Types (IL)](/marketplaces-and-platforms/seller-reference/seller-incorporation-types-il). `0` for Individual."},"seller_inc_code":{"type":"string","description":"Business registration number (ח.פ or ע.מ)."},"seller_registration_date":{"type":"string","description":"Business registration date, `yyyy-mm-dd`, or `null`."},"seller_merchant_name":{"type":"string","description":"Business name."},"seller_merchant_name_en":{"type":"string","description":"Business name in English."},"seller_dba":{"type":"string","description":"Trading name (doing business as)."},"seller_dba_en":{"type":"string","description":"Trading name in English."},"seller_business_type":{"type":"integer","description":"Business field code (`seller_person_business_type` on create-seller). See [MCC List](/marketplaces-and-platforms/seller-reference/mcc-list)."},"seller_site_url":{"type":"string","description":"Seller's website."},"seller_description":{"type":"string","description":"Description of the business."},"seller_retail_type":{"type":"integer","description":"`1` card not present (online), `2` card present, `4` phone or mail order (MOTO)."},"seller_contact_email":{"type":"string","description":"Contact email shown to buyers."},"seller_contact_phone":{"type":"string","description":"Contact phone shown to buyers."},"seller_bank_account_code":{"type":"string","description":"Bank code (`seller_bank_code` on create-seller). See [Banks in Israel](/payments/codes-statuses/banks-in-israel)."},"seller_bank_account_branch":{"type":"string","description":"Bank branch (`seller_bank_branch` on create-seller)."},"seller_bank_account_number":{"type":"string","description":"Bank account number."},"seller_bank_routing_number_foreign":{"type":"string","description":"Routing number of a bank account abroad, or `null`."},"seller_bank_account_number_foreign":{"type":"string","description":"Number of a bank account abroad, or `null`."},"seller_need_foreign_currency":{"type":"boolean","description":"The seller's answer: needs to process foreign currencies. `null` if not answered."},"seller_was_rejected_by_bank":{"type":"boolean","description":"The seller's answer: was rejected by a bank before. `null` if not answered."},"seller_bank_rejection_reason":{"type":"string","description":"The reason the seller gave for the bank rejection, or `null`."},"seller_source_of_finance":{"type":"string","description":"Source of the business's funds, as a name, or `null`."},"seller_required_service_type":{"type":"string","description":"Service type the seller asked for, as a name, or `null`."},"seller_account_type":{"type":"string","description":"Account type: `Deferred`, `Restricted`, `Unrestricted`, `Accounting` or `POS`."}}},"seller_address":{"type":"object","description":"The business address.","properties":{"seller_address_city":{"type":"string","description":"City."},"seller_address_street":{"type":"string","description":"Street."},"seller_address_street_number":{"type":"string","description":"Street number."},"seller_address_country":{"type":"string","description":"Country, ISO 3166-1 alpha-2 code."}}},"seller_fees":{"type":"object","description":"This seller's fee settings. Rates are percent strings (`\"2.50\"` = 2.5%), and `*_processing_charge` is a fixed charge in major units. `foreign` is for foreign cards, `forcurr` for sales in a foreign currency.","properties":{"fee_market_fee":{"type":"string","description":"Default platform (market) fee you take on this seller's sales, percent."},"fee_default_processing_fee":{"type":"string","description":"Processing rate, percent."},"fee_default_processing_charge":{"type":"string","description":"Fixed charge per transaction, in major units."},"fee_default_rapid_settlement_fee":{"type":"string","description":"Rapid settlement rate, percent."},"fee_default_discount_fee":{"type":"string","description":"Discount rate (early settlement of installments) per installment, percent."},"fee_default_premium_processing_fee":{"type":"string","description":"Processing rate for premium cards, percent."},"fee_corporate_processing_fee":{"type":"string","description":"Processing rate for corporate cards, percent."},"fee_foreign_processing_fee":{"type":"string","description":"Processing rate for foreign cards, percent."},"fee_foreign_processing_charge":{"type":"string","description":"Fixed charge per transaction on foreign cards, in major units."},"fee_foreign_rapid_settlement_fee":{"type":"string","description":"Rapid settlement rate for foreign cards, percent."},"fee_foreign_discount_fee":{"type":"string","description":"Discount rate for foreign cards, percent."},"fee_foreign_premium_processing_fee":{"type":"string","description":"Processing rate for foreign premium cards, percent."},"fee_foreign_corporate_processing_fee":{"type":"string","description":"Processing rate for foreign corporate cards, percent."},"fee_forcurr_processing_fee":{"type":"string","description":"Processing rate for sales in a foreign currency, percent."},"fee_forcurr_processing_charge":{"type":"string","description":"Fixed charge per transaction in a foreign currency, in major units."},"fee_forcurr_rapid_settlement_fee":{"type":"string","description":"Rapid settlement rate for sales in a foreign currency, percent."},"fee_forcurr_discount_fee":{"type":"string","description":"Discount rate for sales in a foreign currency, percent."},"fee_forcurr_premium_processing_fee":{"type":"string","description":"Processing rate for premium cards in a foreign currency, percent."},"fee_forcurr_corporate_processing_fee":{"type":"string","description":"Processing rate for corporate cards in a foreign currency, percent."}}},"seller_currencies":{"type":"array","description":"Currencies the seller can sell in, as ISO 4217 codes."},"seller_processing_percent":{"type":"number","description":"Share of the seller's processing limit used, percent."},"seller_processing_limit":{"type":"integer","description":"The seller's processing limit."},"seller_timezone":{"type":"string","description":"The seller's timezone."},"seller_display_language":{"type":"string","description":"The seller's language, for example `he` or `en`."},"seller_wallets":{"type":"object","description":"Balances, one entry per currency, keyed by the currency code. Not returned with `api_mode` `slim`.","properties":{"ILS":{"type":"object","description":"The wallet in this currency.","properties":{"wallet_currency":{"type":"string","description":"Currency of the wallet."},"wallet_total":{"type":"integer","description":"Everything PayMe holds for the seller in this currency, in minor units."},"wallet_releasable":{"type":"integer","description":"The part past its release date, available to withdraw, in minor units."}}}}},"seller_monthly_invoices":{"type":"object","description":"PayMe's monthly invoices to the seller, keyed by invoice document number. Not returned with `api_mode` `slim`.","properties":{"1234":{"type":"object","description":"One invoice.","properties":{"invoice_reference":{"type":"string","description":"Month the invoice covers, `yyyy-mm`."},"invoice_created":{"type":"string","description":"Invoice date, `yyyy-mm-dd`."},"invoice_doc_number":{"type":"string","description":"Invoice document number."},"invoice_currency":{"type":"string","description":"Invoice currency."},"invoice_url":{"type":"string","description":"Link to the invoice PDF."},"invoice_details_url":{"type":"string","description":"Link to the invoice details page."}}}}},"seller_monthly_balance_authorizations":{"type":"object","description":"Links to the seller's monthly balance statements, keyed by year and then by month (`1`–`12`). A month appears from the 10th of the following month. Not returned with `api_mode` `slim`."}}}}}},"example":{"status_code":0,"items_count":1,"items":[{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_id":"store-1001","seller_created":"2026-01-01 15:15:15","seller_active":true,"seller_approved":true,"seller_approved_date":"2026-01-05 10:00:00","seller_is_deferred":false,"seller_withdrawal_plan":1,"seller_withdrawal_date":null,"seller_allow_foreign_cards":true,"seller_personal_details":{"seller_first_name":"Dana","seller_last_name":"Levi","seller_first_name_en":"Dana","seller_last_name_en":"Levi","seller_social_id":"000000018","seller_social_id_country":"IL","seller_social_id_issued":"2015-02-01","seller_birthdate":"1989-05-06","seller_date_of_birth":"1989-05-06","seller_gender":1,"seller_email":"dana@example.com","seller_phone":"0500000005","seller_has_criminal_record":false},"seller_business_details":{"seller_inc":2,"seller_inc_code":"000000018","seller_registration_date":null,"seller_merchant_name":"Dana Ceramics","seller_merchant_name_en":"Dana Ceramics","seller_dba":"Dana Ceramics","seller_dba_en":"Dana Ceramics","seller_business_type":10004,"seller_site_url":"https://www.example.com","seller_description":"Handmade ceramics","seller_retail_type":1,"seller_contact_email":"contact@example.com","seller_contact_phone":"031234567","seller_bank_account_code":"12","seller_bank_account_branch":"123","seller_bank_account_number":"123456","seller_bank_routing_number_foreign":null,"seller_bank_account_number_foreign":null,"seller_need_foreign_currency":null,"seller_was_rejected_by_bank":null,"seller_bank_rejection_reason":null,"seller_source_of_finance":null,"seller_required_service_type":null,"seller_account_type":"Unrestricted"},"seller_address":{"seller_address_city":"Tel Aviv","seller_address_street":"Herzl","seller_address_street_number":"10","seller_address_country":"IL"},"seller_fees":{"fee_market_fee":"1.50","fee_default_processing_fee":"2.50","fee_default_processing_charge":"1.20","fee_default_rapid_settlement_fee":"0.00","fee_default_discount_fee":"0.50","fee_default_premium_processing_fee":"2.50","fee_corporate_processing_fee":"2.50","fee_foreign_processing_fee":"3.50","fee_foreign_processing_charge":"1.20","fee_foreign_rapid_settlement_fee":"0.00","fee_foreign_discount_fee":"0.50","fee_foreign_premium_processing_fee":"3.50","fee_foreign_corporate_processing_fee":"3.50","fee_forcurr_processing_fee":"3.50","fee_forcurr_processing_charge":"0.30","fee_forcurr_rapid_settlement_fee":"0.00","fee_forcurr_discount_fee":"0.50","fee_forcurr_premium_processing_fee":"3.50","fee_forcurr_corporate_processing_fee":"3.50"},"seller_currencies":["ILS","USD"],"seller_processing_percent":12,"seller_processing_limit":100000,"seller_timezone":"Asia/Jerusalem","seller_display_language":"he","seller_wallets":{"ILS":{"wallet_currency":"ILS","wallet_total":10000,"wallet_releasable":2500},"USD":{"wallet_currency":"USD","wallet_total":0,"wallet_releasable":0}},"seller_monthly_invoices":{"1234":{"invoice_reference":"2026-09","invoice_created":"2026-10-01","invoice_doc_number":"1234","invoice_currency":"ILS","invoice_url":"https://example.com/invoices/1234.pdf","invoice_details_url":"https://example.com/invoice-details/1234"}},"seller_monthly_balance_authorizations":{"2026":{"9":"https://example.com/balance/2026-09"}}}]}}}},"500":{"description":"Error. Most errors return HTTP 500. Paging errors (`52`, `27`) return HTTP 400. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}},"/get-withdrawals":{"post":{"operationId":"post-get-withdrawals","summary":"List withdrawals","tags":["Query APIs"],"description":"Returns past withdrawals (payouts to the seller's bank account) for one seller or all your sellers. Canceled withdrawals are not returned. Use `withdrawal_payme_code` to match a withdrawal to the `withdrawal_id` from withdraw-balance and to the `tran_payme_code` of the `withdrawal-complete` callback. To match a withdrawal to its sales, see [Reconcile sales and withdrawals](/accepting-payments/reporting/reconcile-sales-and-withdrawals).\n\nA 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.\n\nWhen you send exactly one `seller_payme_id`, the response also returns it at the top level, with `seller_id`. An inactive seller then returns error `163`, and a seller that isn't yours returns error `20`.\n\nFilters are exact matches, except `withdrawal_created_min` / `withdrawal_created_max`. Most filters take a single value or an array of up to 100 values. Dates are `yyyy-mm-dd hh:mm:ss`, Asia/Jerusalem time.\n\nResults 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](/payments/query-apis).","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Partner key. Partners only. Can also be sent in the `PayMe-Partner-Key` header. Without `seller_payme_id`, the query covers all your sellers."},"seller_payme_id":{"type":"string","description":"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."},"withdrawal_payme_code":{"type":"integer","description":"PayMe's withdrawal code (the `withdrawal_id` from withdraw-balance)."},"withdrawal_created":{"type":"string","description":"Exact creation date and time, `yyyy-mm-dd hh:mm:ss`."},"withdrawal_created_min":{"type":"string","description":"Created at or after this time, `yyyy-mm-dd hh:mm:ss`."},"withdrawal_created_max":{"type":"string","description":"Created at or before this time, `yyyy-mm-dd hh:mm:ss`."},"withdrawal_total":{"type":"integer","description":"Exact amount, in minor units (`5075` = 50.75)."},"withdrawal_currency":{"type":"string","description":"Withdrawal currency, 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code."},"page":{"type":"integer","description":"Page number, `1`–`1000`. Default `1`. Out of range returns error `52`."},"page_size":{"type":"integer","description":"Items per page, `1`–`500`. Default `500`. Out of range returns error `27`."},"items_order_by_column":{"type":"string","description":"Field to sort by, for example `withdrawal_created`. Without it, the order isn't guaranteed and `items_order_by_direction` is ignored."},"items_order_by_direction":{"type":"string","description":"`asc` (default) or `desc`, in upper or lower case. Used only with `items_order_by_column`. Any other value returns error `28`."}}},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","withdrawal_created_min":"2026-10-01 00:00:00","items_order_by_column":"withdrawal_created","items_order_by_direction":"desc"}}},"description":"Every field is optional. Send at least your credentials."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"seller_payme_id":{"type":"string","description":"The seller, when exactly one `seller_payme_id` was sent; otherwise `null`."},"seller_id":{"type":"string","description":"Your own ID for that seller, or `null`."},"items_count":{"type":"integer","description":"Number of items on this page. There is no total count."},"items":{"type":"array","description":"The withdrawals.","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL."},"withdrawal_payme_code":{"type":"integer","description":"PayMe's withdrawal code."},"withdrawal_created":{"type":"string","description":"When the withdrawal was created, `yyyy-mm-dd hh:mm:ss`, Asia/Jerusalem."},"withdrawal_currency":{"type":"string","description":"Currency, 3-letter ISO 4217 code."},"withdrawal_total":{"type":"integer","description":"Amount paid out, in minor units."},"withdrawal_source":{"type":"integer","description":"Who pays it out: `1` PayMe; another value is a card company that pays the seller directly."},"withdrawal_card_brand":{"type":"integer","description":"Card brand the withdrawal covers, when a card company pays the seller directly."},"withdrawal_is_reconciled":{"type":"boolean","description":"`true` when PayMe has matched the payout with its records."},"withdrawal_description":{"type":"string","description":"Always empty. Kept for older integrations."}}}}}},"example":{"status_code":0,"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_id":"store-1001","items_count":1,"items":[{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","withdrawal_payme_code":10001,"withdrawal_created":"2026-10-15 15:15:15","withdrawal_currency":"ILS","withdrawal_total":600000,"withdrawal_source":1,"withdrawal_card_brand":1,"withdrawal_is_reconciled":true,"withdrawal_description":""}]}}}},"500":{"description":"Error. Most errors return HTTP 500. Paging errors (`52`, `27`) return HTTP 400. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}},"/get-future-withdrawals":{"post":{"operationId":"get-future-withdrawals","summary":"List future withdrawals","tags":["Query APIs"],"description":"Projects a seller's upcoming withdrawals in one currency, from the funds waiting for release and the seller's withdrawal plan. Use it to show the next payout dates and amounts.\n\nA seller sends its own `seller_payme_id` (in the body or the `PayMe-Merchant-Key` header). A partner sends `payme_client_key` with the seller's `seller_payme_id` or your own `seller_id`. Send `currency` too. One seller and one currency per call.\n\nYou get `limit` items: `limit − 1` scheduled payouts, then one summary item with `end_time` `-1` that holds everything due later. Amounts are in minor units. When card companies pay the seller directly, the items are split by release date, `source` and `card_brand`, with `withdrawable` `0`.\n\nThe call doesn't page. It is rate limited per seller: on HTTP 429 (error `998`), wait for the `Retry-After` time and retry. A missing `currency` returns error `1`, and an unknown one returns error `24`.","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key, instead of `payme_client_key` in the body. Partners only.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's own MPL, instead of `seller_payme_id` in the body.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL. Required unless a partner sends `seller_id`. Can also be sent in the `PayMe-Merchant-Key` header."},"payme_client_key":{"type":"string","description":"Partner key. Required with `seller_id`. Can also be sent in the `PayMe-Partner-Key` header."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent to create-seller. Partners only, with `payme_client_key`."},"currency":{"type":"string","description":"Wallet currency, 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code, for example `ILS`."},"limit":{"type":"integer","description":"Number of items to return, including the final summary item. Default `7`."},"language":{"type":"string","description":"Language of `source_text` and `card_brand_text`: `he` (default) or `en`."}},"required":["currency"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","currency":"ILS","limit":3,"language":"en"}}},"description":"Send `currency` and identify one seller."},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"withdrawal_plan":{"type":"integer","description":"The seller's withdrawal plan: `1` manual, `2` daily, `3` monthly."},"currency":{"type":"string","description":"The currency you asked for."},"items_count":{"type":"integer","description":"Number of items."},"items":{"type":"array","description":"Expected payouts, then one summary item.","items":{"type":"object","properties":{"start_time":{"type":"integer","description":"Start of the period the payout covers, Unix epoch."},"end_time":{"type":"integer","description":"Expected payout time, Unix epoch. `-1` on the summary item."},"created_at":{"type":"string","description":"Expected payout date and time, `yyyy-mm-dd hh:mm:ss`. On the summary item, the current time."},"withdrawable":{"type":"integer","description":"`1` paid out by PayMe; `0` paid directly by a card company."},"source":{"type":"integer","description":"Who pays it out: `1` PayMe, other values a card company."},"source_text":{"type":"string","description":"Name of `source`, in the requested `language`."},"card_brand":{"type":"integer","description":"Card brand code."},"card_brand_text":{"type":"string","description":"Name of `card_brand`, in the requested `language`."},"total":{"type":"string","description":"Expected amount, in minor units."},"withdrawal_payme_code":{"type":"string","description":"Opaque token for this expected payout. It's not a withdrawal code from get-withdrawals."}}}}}},"example":{"status_code":0,"withdrawal_plan":2,"currency":"ILS","items_count":3,"items":[{"start_time":1793836800,"end_time":1793923200,"created_at":"2026-11-06 02:00:00","withdrawable":1,"source":1,"source_text":"PayMe","card_brand":1,"card_brand_text":"Other","total":"48250","withdrawal_payme_code":"<opaque-token>"},{"start_time":1793923200,"end_time":1794009600,"created_at":"2026-11-07 02:00:00","withdrawable":1,"source":1,"source_text":"PayMe","card_brand":1,"card_brand_text":"Other","total":"0","withdrawal_payme_code":"<opaque-token>"},{"start_time":1794009600,"end_time":-1,"created_at":"2026-11-05 14:00:20","withdrawable":1,"source":1,"source_text":"PayMe","card_brand":1,"card_brand_text":"Other","total":"156390","withdrawal_payme_code":"<opaque-token>"}]}}}},"500":{"description":"Error. Most errors return HTTP 500; the rate limit (`998`) returns HTTP 429. The body is the same. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"currency","status_error_code":1}}}}}}},"/banks/{country_iso_code}":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-banks-country-iso-code","summary":"List banks","tags":["Query APIs"],"description":"Returns the bank codes for a country. Use them as `seller_bank_code` when you create or update a seller. Only Israel (`IL`) has banks today; other countries return an empty list. The same list is on [Banks in Israel](/payments/codes-statuses/banks-in-israel).\n\nSend your partner key in the `PayMe-Partner-Key` header, or a seller's MPL in the `PayMe-Merchant-Key` header. One of them is required: without either, the call fails with error `1`. The list isn't paged.","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Partner key. Send this or `PayMe-Merchant-Key`.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"A seller's MPL. Send this or `PayMe-Partner-Key`.","schema":{"type":"string"}},{"name":"country_iso_code","in":"path","required":true,"description":"ISO 3166-1 alpha-2 country code, case-insensitive, for example `IL`. An unknown code returns HTTP 422 with error `912`.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"page":{"type":"integer","description":"Always `1`."},"items_per_page":{"type":"integer","description":"Number of banks returned."},"items_total":{"type":"integer","description":"Number of banks returned."},"country_iso_code":{"type":"string","description":"The country code you sent."},"items":{"type":"array","description":"The banks.","items":{"type":"object","properties":{"code":{"type":"string","description":"Bank code. Send it as `seller_bank_code`."},"local_name":{"type":"string","description":"Bank name in the local language."},"international_name":{"type":"string","description":"Bank name in English."}}}}}},"example":{"status_code":0,"page":1,"items_per_page":1,"items_total":1,"country_iso_code":"IL","items":[{"code":"12","local_name":"בנק הפועלים","international_name":"Bank Hapoalim"}]}}}},"500":{"description":"Error. A missing key returns HTTP 500 with error `1`. An unknown country code returns HTTP 422 with error `912`. See [Errors](/payments/getting-started/errors).","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code."},"status_error_details":{"type":"string","description":"Error message."},"status_additional_info":{"type":"string","description":"The field the error refers to, when there is one."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1}}}}}}}}}