# PayMe API Documentation > Developer documentation for PayMe, an Israeli payments provider: the Payments API for accepting card, wallet and bank payments through a hosted payment page, hosted fields or a direct API, plus the B2B Payments, Keep accounting and Products & Customers APIs, with sandbox and production environments. ## Start here - [Start Here](https://docs-staging.payme.io/payments-migrated/getting-started/start-here): Reading order for developers and AI coding agents integrating the PayMe Payments API: 1) PayMe at a glance, 2) Authentication (seller_payme_id/MPL, payme_client_key, public key), 3) Environments (sandbox.payme.io vs live.payme.io), 4) Quickstart (generate-sale, pay, callback, refund-sale), 5) Callbacks (form-encoded POST, notify_type, payme_signature). Then Errors and Idempotency & Retries. - [PayMe at a Glance](https://docs-staging.payme.io/payments-migrated/getting-started/payme-at-a-glance): PayMe is a payments provider whose Payments API lets platforms and merchants accept payments through a hosted payment page, hosted fields (JSAPI) or a direct API, with tokenization, subscriptions, refunds, authorization and capture, 3D Secure, invoices and point-of-sale. Other APIs: B2B Payments, Keep (accounting) and Products & Customers. Payment methods include cards, Bit, Apple Pay, Google Pay, PayPal, bank transfer, SEPA, BACS and Israeli direct debit. Sandbox: sandbox.payme.io/api; production: live.payme.io/api. - [Authentication](https://docs-staging.payme.io/payments-migrated/getting-started/authentication): Payments API requests carry credentials in the JSON body, not an Authorization header: seller_payme_id (the MPL, identifies the seller) on almost every call, and payme_client_key (PayMe partner key) on refunds, seller management and query APIs. Some endpoints take them as headers PayMe-Merchant-Key / PayMe-Partner-Key. A public key (PayMe-Public-Key) is used from the browser for Hosted Fields and 3D Secure. Keep uses OAuth2 client credentials; Products & Customers uses a JWT from POST /auth/token. - [Environments](https://docs-staging.payme.io/payments-migrated/getting-started/environments): PayMe has two environments: Sandbox at https://sandbox.payme.io/api/ and Production at https://live.payme.io/api/; use matching credentials for each. Test only in the sandbox with the documented test cards. The sandbox generate-sale example returns sale_url on preprod.paymeservice.com, while other examples show sandbox.payme.io — the reason is not documented. Hosted Fields and Apple/Google Pay JS use testMode: true for the sandbox. - [Quickstart](https://docs-staging.payme.io/payments-migrated/getting-started/quickstart): End-to-end sandbox walkthrough. 1) POST https://sandbox.payme.io/api/generate-sale with seller_payme_id, sale_price (minor units, min 500), currency, product_name, transaction_id, sale_callback_url, sale_return_url, language en; response has sale_url and payme_sale_id. 2) Open sale_url and pay with test card 5326105300985846 12/30 CVV 658. 3) PayMe POSTs a form-encoded callback with notify_type sale-complete. 4) POST /refund-sale with payme_client_key, seller_payme_id, payme_sale_id and optional sale_refund_amount. - [Callbacks](https://docs-staging.payme.io/payments-migrated/getting-started/callbacks): PayMe callbacks (also called IPN) are server-to-server POST requests with an x-www-form-urlencoded body sent to sale_callback_url, or to the merchant's default callback URL. notify_type is one of sale-complete, sale-authorized, refund, sale-failure, sale-chargeback, sale-chargeback-refund. The payload includes status_code, payme_sale_id, transaction_id, sale_status, price, currency, buyer_key (when capture_buyer was set) and payme_signature (documented as an MD5 signature; algorithm and inputs not documented). - [Errors](https://docs-staging.payme.io/payments-migrated/getting-started/errors): Payments API errors return status_code 1 with status_error_code (numeric code), status_error_details (message, Hebrew by default; send language en for English) and status_additional_info (often the offending field name). Documented examples return errors with HTTP 500, so check status_code in the body. Codes seen in the docs: 1 missing parameter, 20 validation, 200 service not found (wrong client key), 251 user link / seller not found, 305 wrong sale status, 356 invalid card expiry, 600 buyer not found, 720 service not activated, 901 invalid JSON, 906 withdrawal not found. - [Idempotency and Retries](https://docs-staging.payme.io/payments-migrated/getting-started/idempotency-and-retries): PayMe documents no idempotency key. transaction_id is your own order ID for correlation; whether PayMe rejects duplicates is not documented. Retrying refund-sale is dangerous: several partial refunds per sale are allowed up to the sale total, so a repeated partial refund is a second refund. Capture runs once; an authorization lasts up to 168 hours. Before retrying a request that timed out, check the sale with POST /get-sales (sale_payme_id) and its sale_status. Rate limits for the Payments API are not documented. - [Test Cards and Payment Methods](https://docs-staging.payme.io/payments-migrated/introduction/test-cards-and-payment-methods): Please use the following credit card when integrating only in the **Sandbox** environment. - [Sale Callbacks](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/sale-callbacks): The callback PayMe sends to your server when a sale is paid, authorized, refunded, fails or is charged back: notification types and every payload field. ## Machine-readable - [Marketplaces & Platforms full text](https://docs-staging.payme.io/guides-and-use-cases-migrated/llms-full.txt): every Marketplaces & Platforms page in one file - [Payments OpenAPI spec](https://docs-staging.payme.io/payments-migrated/openapi.json): the OpenAPI document (also as [YAML](https://docs-staging.payme.io/payments-migrated/openapi.yaml)) - [Payments tool definitions](https://docs-staging.payme.io/api/v1/projects/payments-migrated/api/tools.json): one function-calling tool per endpoint - [Payments full text](https://docs-staging.payme.io/payments-migrated/llms-full.txt): every Payments page in one file - [B2B Payments OpenAPI spec](https://docs-staging.payme.io/b2b-payments-migrated/openapi.json): the OpenAPI document (also as [YAML](https://docs-staging.payme.io/b2b-payments-migrated/openapi.yaml)) - [B2B Payments tool definitions](https://docs-staging.payme.io/api/v1/projects/b2b-payments-migrated/api/tools.json): one function-calling tool per endpoint - [B2B Payments full text](https://docs-staging.payme.io/b2b-payments-migrated/llms-full.txt): every B2B Payments page in one file - [Keep OpenAPI spec](https://docs-staging.payme.io/keep-api-migrated/openapi.json): the OpenAPI document (also as [YAML](https://docs-staging.payme.io/keep-api-migrated/openapi.yaml)) - [Keep tool definitions](https://docs-staging.payme.io/api/v1/projects/keep-api-migrated/api/tools.json): one function-calling tool per endpoint - [Keep full text](https://docs-staging.payme.io/keep-api-migrated/llms-full.txt): every Keep page in one file - [Products and Customers OpenAPI spec](https://docs-staging.payme.io/products-and-customers-migrated/openapi.json): the OpenAPI document (also as [YAML](https://docs-staging.payme.io/products-and-customers-migrated/openapi.yaml)) - [Products and Customers tool definitions](https://docs-staging.payme.io/api/v1/projects/products-and-customers-migrated/api/tools.json): one function-calling tool per endpoint - [Products and Customers full text](https://docs-staging.payme.io/products-and-customers-migrated/llms-full.txt): every Products and Customers page in one file - [eCommerce full text](https://docs-staging.payme.io/ecommerce/llms-full.txt): every eCommerce page in one file - [All documentation, full text](https://docs-staging.payme.io/llms-full.txt): every page in one file - [MCP server](https://docs-staging.payme.io/mcp): Model Context Protocol over Streamable HTTP — search the docs, read pages, endpoints and OpenAPI specs - [Search API](https://docs-staging.payme.io/api/v1/search?q=): GET with `q=`; returns matching pages as JSON - CLI: `npx -p @payme-io/docs-cli payme-docs` — manage these docs from a terminal or CI with an API key (package `@payme-io/docs-cli`); to read them, use the Markdown URLs, MCP or the search API - Markdown: append `.md` to any page URL for that page as Markdown - Source: append `.yaml` to an endpoint page URL (a line that reads `METHOD path — summary`) for its source YAML; guide pages have no YAML ## Marketplaces & Platforms How-to guides for platforms and marketplaces on PayMe: onboarding sellers, Apple Pay, Google Pay, bank transfer, Israeli direct debit, capture, 3D Secure and reporting, plus reference lists of statuses, types and codes. ### Overview - [Merchant Default URLs](https://docs-staging.payme.io/guides-and-use-cases-migrated/overview/merchant-default-urls): Upon creating your Merchant account with us, you will be required to provide a few default URLs for various calls. More examples can be found further in the documentation. ### Payments - [Apple Pay](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/apple-pay): The payment method is limited to be used in the following devices manufactured by Apple: - [Apple Pay - Full Flow Control](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/apple-pay-full-flow-control): The payment method is limited to be used in the following devices manufactured by Apple: - [Google Pay](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/google-pay): Google Pay™ allows your customers to pay quickly and securely using payment methods saved in their Google Account. Google Pay is fully compatible with PayMe’s products and features: You can use it for traditional payments and multi payments page. - [Bank transfer](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/bank-transfer): How to take a bank-transfer payment: create a pending bank transfer, wait for the callback, and treat `PAID` as funds received. - [Israeli Direct Debit](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/israeli-direct-debit): In order to create a direct debit mandate for Israeli customers, you can use our generate-sale API endpoint to complete the two actions of: 1. Generating a mandate request. 2. Generating a new payment request. - [Point Of Sale](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/point-of-sale): A POS system allows your business to accept payments from customers and keep track of sales. It sounds simple enough, but the setup can work in different ways, depending on whether you sell online, have a physical storefront, or both. - [Multi Payment Page](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/multi-payment-page): Also known as “Template Sale”. Enables payments on a single sale link, by multiple buyers. For example, you will be able to generate a single sale and share its payment link on any social network site to allow multiple customers to pay on their own. Every payment will create a new sale with a different ID. Creation of a template sale should be done by adding the `sale_type="template"` attribute to the request: - [Multi Capture](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/multi-capture): The guide will be a run-through the process of using our Multi-Capture logic for card payments. - [Multi Capture Paypal](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/multi-capture-paypal): The guide will be a run-through the process of using our Multi-Capture logic for Paypal payments. - [Capture sale](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/capture-sale): Also known as “Pre-Authorization”. The requested amount gets reserved (blocked) on the credit card of the buyer for up to 168 hours. A following Capture request will trigger the actual settlement of the funds. Please note that attempting to Capture after the allowed period of time (168 hours) will result in an error. - [Create Payment With Buyer Key (Token)](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/create-payment-with-buyer-key-token): Allows for token capture upon the buyer's payment (submission of payment details). - [How to create subscription](https://docs-staging.payme.io/guides-and-use-cases-migrated/payments/how-to-create-subscription): Diagram of the steps to create a recurring subscription payment with PayMe. ### 3D Secure - [3D Secure Guide](https://docs-staging.payme.io/guides-and-use-cases-migrated/3d-secure/3d-secure-guide): 3-D Secure is a protocol designated to redurce fradulant transactions and protect merchants from losing the funds for those transactions. The name refers to the "three domains" which interact using the protocol: the merchant/acquirer domain, the issuer domain, and the interoperability domain. Our API is designed to allow platforms to offer a full payment solution as part of their product.Using the API you can allow sellers accept 3DSecure authorizations for credit card payments. - [3D Secure as a Service](https://docs-staging.payme.io/guides-and-use-cases-migrated/3d-secure/3d-secure-as-a-service): The standalone 3D Secure service enables you to leverage the 3D Secure capabilities of PayMe in an independent API request, without executing the usual purchase or authorization transaction that triggers 3D Secure authentication. ### Integrations - [Hosted Fields JSAPI Guide](https://docs-staging.payme.io/guides-and-use-cases-migrated/integrations/hosted-fields-jsapi-guide): How to embed PayMe Hosted Fields (the JavaScript API) in your checkout page: load the library, initialise it with your merchant API key, mount the card fields, and pay a sale. - [Direct API - How to create and pay sale](https://docs-staging.payme.io/guides-and-use-cases-migrated/integrations/direct-api-how-to-create-and-pay-sale): To initiate and pay a sale, please adhere to the following steps: ### Capabilities - [Pre-Fill payment page](https://docs-staging.payme.io/guides-and-use-cases-migrated/capabilities/pre-fill-payment-page): You can pass your buyer's details to our payment page, to pre-fill the form. ### Sellers - [Create Seller](https://docs-staging.payme.io/guides-and-use-cases-migrated/sellers/create-seller): **This endpoint is relevant only to PayMe's partners.** ### Reporting - [Kinds of reports](https://docs-staging.payme.io/guides-and-use-cases-migrated/reporting/kinds-of-reports): Using our API and system, you can export different kinds of reports. - [Queries APIs guides](https://docs-staging.payme.io/guides-and-use-cases-migrated/reporting/queries-apis-guides): > For API reference, please head over to our APIs section using the sidebar on the left. ### Lists & Statuses - [Sale Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/sale-types): Reference list of PayMe sale types and their numbers, such as sale (J4), authorize (J5), token and template. - [Sale Statuses](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/sale-statuses): Reference list of sale statuses, from `initial` and `completed` to `refunded`, `chargeback` and `voided`, with what each means. - [Transaction Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/transaction-types): Reference list of transaction type numbers, such as Sale, Token, Authorization/Void and Balance. - [Transaction Statuses](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/transaction-statuses): Reference list of transaction statuses, from `pending` and `validated` to refunds, chargebacks and voids. - [Subscription Statuses](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/subscription-statuses): Reference list of subscription statuses — initial, active, paused, failed, cancelled, completed, and failed pending automatic retry. - [Subscription Iteration Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/subscription-iteration-types): Reference list of subscription billing intervals: daily, weekly, monthly and annually. - [Bank Authorization Statuses](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/bank-authorization-statuses): Reference list of Israeli direct-debit bank authorization statuses sent in callbacks, such as opened, failed, cancelled by the account owner and reactivated. - [Banks in Israel](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/banks-in-israel): Reference list of Israeli bank names and their bank codes, used when entering seller or buyer bank details. - [File Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/file-types): Reference list of document file-type codes for uploading seller files, such as ID, bank account ownership and incorporation certificate. - [Document Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/document-types): Reference list of document type codes you can generate, such as order, invoice, invoice receipt, refund and receipt. - [MCC List](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/mcc-list): Reference list of PayMe merchant category codes (MCC) with Hebrew and English descriptions of each business type. - [Individual Seller Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/individual-seller-types): Reference list of role codes for individuals linked to a seller: owner, signatory, director, executive and back office. - [Seller Incorporation Types (IL)](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/seller-incorporation-types-il): Reference list of Israeli business incorporation type codes, such as sole proprietorship, company, partnership and non-profit. - [VAS Types](https://docs-staging.payme.io/guides-and-use-cases-migrated/lists-statuses/vas-types): Reference list of value-added service (VAS) type codes, such as invoices, SMS, antifraud, marketplace and POS. ## Payments 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. ### Introduction - [Getting Started](https://docs-staging.payme.io/payments-migrated/introduction/getting-started): Our API is designed to allow platforms to offer a full payment solution as part of their product. - [Sandbox and Production URLs](https://docs-staging.payme.io/payments-migrated/introduction/sandbox-and-production-urls): In order to work with the API, you should use the service URLs according to the required environments, Sandbox or Production.When interacting with the API, make sure you point to the correct environment, with the correct credentials. Both URLs will be stated next to each function. - [Value Added Services](https://docs-staging.payme.io/payments-migrated/introduction/value-added-services): At PayMe, We go beyond traditional financial solutions to offer a comprehensive suite of value-added services. These services are designed to enhance our clients' financial experiences and empower them with the tools they need for success. From the creation of invoices and security services to seamless integration with third-party platforms, our value-added services cater to the diverse needs of your business. - [Payment Options](https://docs-staging.payme.io/payments-migrated/introduction/payment-options): We have three integration options: - [Hosted Payment Page](https://docs-staging.payme.io/payments-migrated/hosted-payment-page/post-generate-sale) - [Hosted Fields - JSAPI](https://docs-staging.payme.io/guides-and-use-cases-migrated/integrations/hosted-fields-jsapi-guide) - [Direct API](https://docs-staging.payme.io/guides-and-use-cases-migrated/integrations/direct-api-how-to-create-and-pay-sale) ### Hosted Payment Page - [Generate Payment](https://docs-staging.payme.io/payments-migrated/hosted-payment-page/post-generate-sale): POST /generate-sale — Generate Payment - [Generate Multi Checkout Payment](https://docs-staging.payme.io/payments-migrated/hosted-payment-page/post-generate-sale-2): POST /generate-sale/ — Generate Multi Checkout Payment ### Hosted Fields - JSAPI - [Generate Payment with Token](https://docs-staging.payme.io/payments-migrated/hosted-fields-jsapi/post-generate-sale-hosted-fields-jsapi): How to call POST /generate-sale for Hosted Fields - JSAPI. ### Direct API - [Available Payment Methods](https://docs-staging.payme.io/payments-migrated/direct-api/available-payment-methods): As PayMe offers different payment methods, you can use the `sale_payment_method` parameter in [`generate-sale`](https://docs-staging.payme.io/payments-migrated) to set your desired payment method. - [Pay Sale](https://docs-staging.payme.io/payments-migrated/direct-api/post-pay-sale): POST /pay-sale — Pay Sale ### Point of Sale (POS) - [Order New POS Device](https://docs-staging.payme.io/payments-migrated/point-of-sale-pos/post-vas-enable): POST /vas-enable — Order New POS Device - [Pair New Device](https://docs-staging.payme.io/payments-migrated/point-of-sale-pos/post-pair): POST /vas/pos/pair — Pair New Device - [Authenticate New Device](https://docs-staging.payme.io/payments-migrated/point-of-sale-pos/post-authenticate): POST /vas/pos/authenticate — Authenticate New Device - [New POS Payment](https://docs-staging.payme.io/payments-migrated/point-of-sale-pos/post-payment): POST /sales — New POS Payment - [Refund POS Sale](https://docs-staging.payme.io/payments-migrated/point-of-sale-pos/put-sales): PUT /sales — Refund POS Sale ### Post Sale Actions - [Refund Sale](https://docs-staging.payme.io/payments-migrated/post-sale-actions/post-refund-sale): POST /refund-sale — Refund Sale - [Void Sale](https://docs-staging.payme.io/payments-migrated/post-sale-actions/void-sale): How to call POST /refund-sale for Post Sale Actions. - [Capture Sale](https://docs-staging.payme.io/payments-migrated/post-sale-actions/post-capture-sale): POST /capture-sale — Capture Sale - [Cancel Multi Payment Page](https://docs-staging.payme.io/payments-migrated/post-sale-actions/post-cancel-template): POST /cancel-template — Cancel Multi Payment Page ### Apple Pay - [Activate Service (Apple Pay)](https://docs-staging.payme.io/payments-migrated/apple-pay/post-vas-enable-apple-pay): How to call POST /vas-enable for Apple Pay. - [Generate Sale with Apple Pay](https://docs-staging.payme.io/payments-migrated/apple-pay/post-generate-sale-apple-pay): How to call POST /generate-sale for Apple Pay. ### Google Pay - [Activate Service (Google Pay)](https://docs-staging.payme.io/payments-migrated/google-pay/post-vas-enable-google-pay): How to call POST /vas-enable for Google Pay. - [Generate Sale with Google Pay](https://docs-staging.payme.io/payments-migrated/google-pay/post-generate-sale-google-pay): How to call POST /generate-sale for Google Pay. ### IL Direct Debit - [Generate New Authorization](https://docs-staging.payme.io/payments-migrated/il-direct-debit/post-generate-sale-il-direct-debit): How to call POST /generate-sale for IL Direct Debit. - [Generate New Payment](https://docs-staging.payme.io/payments-migrated/il-direct-debit/post-generate-sale-2-il-direct-debit): How to call POST /generate-sale for IL Direct Debit. ### Subscriptions - [Generate](https://docs-staging.payme.io/payments-migrated/subscriptions/post-generate-subscription): POST /generate-subscription — Generate - [Recurring Payments](https://docs-staging.payme.io/payments-migrated/subscriptions/recurring-payments): Recurring payments help you to oversee regular payments for subscriptions, providing convenience to customers and predictable revenue streams for your business. - [Pay](https://docs-staging.payme.io/payments-migrated/subscriptions/post-generate-subscription-2): POST /pay-subscription — Pay - [Cancel](https://docs-staging.payme.io/payments-migrated/subscriptions/postcancel-subscription): POST /cancel-subscription — Cancel - [Pause](https://docs-staging.payme.io/payments-migrated/subscriptions/post-pause-subscription): POST /pause-subscription — Pause - [Resume](https://docs-staging.payme.io/payments-migrated/subscriptions/patch-subscriptions-sub-payme-id-resume): PATCH /subscriptions/{sub_payme_id}/resume — Resume - [Update Price](https://docs-staging.payme.io/payments-migrated/subscriptions/patch-subscriptions-sub-id-set-price): PATCH /subscriptions/{sub_id}/set-price — Update Price ### Tokenization - [Capture Buyer Token](https://docs-staging.payme.io/payments-migrated/tokenization/post-capture-buyer-token): POST /capture-buyer-token — Capture Buyer Token - [Generate Sale with Token](https://docs-staging.payme.io/payments-migrated/tokenization/post-generate-sale-tokenization): How to call POST /generate-sale for Tokenization. - [Get Buyer Key](https://docs-staging.payme.io/payments-migrated/tokenization/post-get-buyer-key): POST /get-buyer-key — Get Buyer Key - [Get card details by token](https://docs-staging.payme.io/payments-migrated/tokenization/post-buyer-token-to-card-number): POST /buyer-token-to-card-number — Get card details by token ### Merchants Management - [Create Seller](https://docs-staging.payme.io/payments-migrated/merchants-management/post-create-seller): POST /create-seller — Create Seller - [Update Seller](https://docs-staging.payme.io/payments-migrated/merchants-management/post-update-seller): POST /update-seller — Update Seller - [Upload Seller Files](https://docs-staging.payme.io/payments-migrated/merchants-management/post-upload-seller-files): POST /upload-seller-files — Upload Seller Files - [Retrieve Seller's Additional Services Data](https://docs-staging.payme.io/payments-migrated/merchants-management/post-get-vas-seller): POST /get-vas-seller — Retrieve Seller's Additional Services Data - [Withdraw Balance](https://docs-staging.payme.io/payments-migrated/merchants-management/post-withdraw-balance): POST /withdraw-balance — Withdraw Balance - [Get Seller Public Key](https://docs-staging.payme.io/payments-migrated/merchants-management/get-sellers-mpl-public-keys): GET /sellers/{seller_payme_id}/public-keys — Get Seller Public Key - [Delayed Market Fee](https://docs-staging.payme.io/payments-migrated/merchants-management/patch-sales-guid-external-market-fee): PATCH /sales/{guid}/external-market-fee — Delayed Market Fee - [Create Individual](https://docs-staging.payme.io/payments-migrated/merchants-management/post-sellers-mpl-key-individuals): POST /sellers/{mpl_key}/individuals — Create Individual - [Update Individual](https://docs-staging.payme.io/payments-migrated/merchants-management/post-sellers-mpl-key-individuals-2): POST /sellers/{mpl_key}/individuals/{individual_key} — Update Individual - [Get-Individuals by Company ID](https://docs-staging.payme.io/payments-migrated/merchants-management/get-sellers-mpl-key-individuals): GET /sellers/{mpl_key}/individuals — Get-Individuals by Company ID - [Get Partner Data](https://docs-staging.payme.io/payments-migrated/merchants-management/get-partners): GET /partners — Get Partner Data - [GET Mids](https://docs-staging.payme.io/payments-migrated/merchants-management/get-sellers-mpl-key-mids): GET /sellers/{mpl_key}/mids — GET Mids - [Business Fields](https://docs-staging.payme.io/payments-migrated/merchants-management/get-business-fields): GET /business-fields — Business Fields ### Buyers Management - [Get Customer Details](https://docs-staging.payme.io/payments-migrated/buyers-management/get-buyers-guid): GET /buyers/{buyer_guid} — Get Customer Details ### Generate a Sale with 3D Secure - [Generate Sale with 3D Secure](https://docs-staging.payme.io/payments-migrated/generate-a-sale-with-3d-secure/post-generate-sale-generate-a-sale-with-3d-secure): How to call POST /generate-sale for Generate a Sale with 3D Secure. ### Standalone 3D Secure service - [Initialize 3DSecure Request](https://docs-staging.payme.io/payments-migrated/standalone-3d-secure-service/post-initialize-3dsecure-request): POST /sales/payme_sale_id/3ds — Initialize 3DSecure Request - [Resolve Secured Hash](https://docs-staging.payme.io/payments-migrated/standalone-3d-secure-service/get-sales-payme-sale-id-3ds-hash): GET /sales/payme_sale_id/3ds/hash — Resolve Secured Hash ### Invoices - [Create Document](https://docs-staging.payme.io/payments-migrated/invoices/post-create-invoice): POST /documents — Create Document - [Get Generated Document By ID](https://docs-staging.payme.io/payments-migrated/invoices/show-generated-document-by-id): GET /documents/document_id — Get Generated Document By ID - [Show Generated Document By ID](https://docs-staging.payme.io/payments-migrated/invoices/show-generated-document-by-id-2): GET /show-documents/document_id — Show Generated Document By ID - [Query Existing Documents](https://docs-staging.payme.io/payments-migrated/invoices/get-documents): GET /documents — Query Existing Documents ### Query APIs - [List Sales](https://docs-staging.payme.io/payments-migrated/query-apis/post-get-sales): POST /get-sales — List Sales - [Reporting & Data](https://docs-staging.payme.io/payments-migrated/query-apis/reporting-data): Access preconfigured reports to gain insight into essential activities, such as sales, transactions, subscriptions, and balance adjustments. - [List Transactions](https://docs-staging.payme.io/payments-migrated/query-apis/post-get-transactions): POST /get-transactions — List Transactions - [List Subscriptions](https://docs-staging.payme.io/payments-migrated/query-apis/post-get-subscriptions): POST /get-subscriptions — List Subscriptions - [List Sellers](https://docs-staging.payme.io/payments-migrated/query-apis/post-get-sellers): POST /get-sellers — List Sellers - [List Past Withdrawals](https://docs-staging.payme.io/payments-migrated/query-apis/post-get-withdrawals): POST /get-withdrawals — List Past Withdrawals - [List Future Withdrawals](https://docs-staging.payme.io/payments-migrated/query-apis/get-future-withdrawals): POST /get-future-withdrawals — List Future Withdrawals - [Aggregated Wallets Data](https://docs-staging.payme.io/payments-migrated/query-apis/get-funds-transfer-aggregated): GET /funds-transfer/aggregated — Aggregated Wallets Data - [List of available banks](https://docs-staging.payme.io/payments-migrated/query-apis/get-banks-country-iso-code): GET /banks/{country_iso_code} — List of available banks - [Wallet to Wallet transfers](https://docs-staging.payme.io/payments-migrated/query-apis/get-funds-transfer): GET /funds-transfer — Wallet to Wallet transfers - [Withdrawal Correlation](https://docs-staging.payme.io/payments-migrated/query-apis/post-credit-match): POST /credit-match — Withdrawal Correlation ### Get Transaction Statistics - [Get Transaction Statistics](https://docs-staging.payme.io/payments-migrated/get-transaction-statistics/post-get-transaction-statistics): POST /get-transaction-statistics — Get Transaction Statistics ### Get Transaction Data - [Get Transaction Data](https://docs-staging.payme.io/payments-migrated/get-transaction-data/post-get-transaction-data): POST /get-transaction-data — Get Transaction Data ### iOS SDK - [iOS SDK](https://docs-staging.payme.io/payments-migrated/ios-sdk/ios-sdk): You can use the PayMe (Isracard Global) iOS SDK to implement payments on iOS devices. The guide covers building and importing the PMLib.framework, initializing the SDK, and integrating the Isracard Global API to pay a sale, pay a subscription, and capture a buyer. ## B2B Payments API reference for business-to-business payments: create payment contracts that send a payment or request one, manage their invoices and recipients, and transfer funds between wallets. ### Contracts - [Create New Contract](https://docs-staging.payme.io/b2b-payments-migrated/contracts/post-user): POST /payment-contracts — Create New Contract - [Get Recipient](https://docs-staging.payme.io/b2b-payments-migrated/contracts/get-api-payment-contracts-recipients-has-matching-balance): GET /payment-contracts/recipients/has-matching-balance — Get Recipient - [Get All Seller Contracts](https://docs-staging.payme.io/b2b-payments-migrated/contracts/get-contracts): GET /payment-contracts/ — Get All Seller Contracts - [Get Contract Related Files](https://docs-staging.payme.io/b2b-payments-migrated/contracts/get-contracts-files): GET /payment-contracts/CONT{GUID}/invoices/ — Get Contract Related Files - [Upload Contract Related Files](https://docs-staging.payme.io/b2b-payments-migrated/contracts/post-contracts-files): POST /payment-contracts/CONT{GUID}/invoices/ — Upload Contract Related Files - [Update Contract Related Files](https://docs-staging.payme.io/b2b-payments-migrated/contracts/put-contracts-files): PUT /payment-contracts/CONT{GUID}/invoices/ — Update Contract Related Files - [Delete Contract Related Files](https://docs-staging.payme.io/b2b-payments-migrated/contracts/delete-contracts-files): DELETE /payment-contracts/CONT{GUID}/invoices/ — Delete Contract Related Files - [Get Recipient](https://docs-staging.payme.io/b2b-payments-migrated/contracts/get-recipient): GET /payment-contracts/recipients — Get Recipient ### Wallets - [Generate Transfer](https://docs-staging.payme.io/b2b-payments-migrated/wallets/post-generate-transfer): POST /sales — Generate Transfer ## Keep APIs for Keep, PayMe's accounting product: partners create and manage sellers, income documents, expenses, and tax and VAT balances, authenticating with OAuth 2.0 client credentials. ### Partner Authorization - [Prerequisites](https://docs-staging.payme.io/keep-api-migrated/partner-authorization/prerequisites): Partner authorization layer protects the Partner's data on the Keep domain against unauthorized access and mutation. - [Authorization Flow](https://docs-staging.payme.io/keep-api-migrated/partner-authorization/authorization-flow): This document provides a high-level overview of the Keep API authentication system. ### Seller API - [List income documents](https://docs-staging.payme.io/keep-api-migrated/seller-api/listsellerincomedocuments): GET /seller/api/documents/income — List income documents - [Seller API](https://docs-staging.payme.io/keep-api-migrated/seller-api/overview): The Seller API lets accounting integrations create, retrieve, cancel, and preview seller income documents such as invoices and receipts. This page is the editable landing for the Seller API category. - [Create income document](https://docs-staging.payme.io/keep-api-migrated/seller-api/createsellerincomedocument): POST /seller/api/documents/income — Create income document - [Get income document](https://docs-staging.payme.io/keep-api-migrated/seller-api/getsellerincomedocument): GET /seller/api/documents/income/{id} — Get income document - [Cancel income document](https://docs-staging.payme.io/keep-api-migrated/seller-api/cancelsellerincomedocument): POST /seller/api/documents/income/{id}/cancel — Cancel income document - [Generate document preview](https://docs-staging.payme.io/keep-api-migrated/seller-api/previewsellerincomedocument): POST /seller/api/documents/income/preview — Generate document preview ### Partners API - [Obtain access token](https://docs-staging.payme.io/keep-api-migrated/partners-api/gettoken): POST /oauth2/token — Obtain access token - [Create seller](https://docs-staging.payme.io/keep-api-migrated/partners-api/createseller): POST /public/sellers/create — Create seller - [Get seller](https://docs-staging.payme.io/keep-api-migrated/partners-api/getsellerbyid): GET /public/sellers/{sellerId} — Get seller - [Get available plans](https://docs-staging.payme.io/keep-api-migrated/partners-api/getpartnerplans): GET /public/plans — Get available plans - [List expenses](https://docs-staging.payme.io/keep-api-migrated/partners-api/listpublicexpenses): GET /public/expenses — List expenses - [Upload expense document](https://docs-staging.payme.io/keep-api-migrated/partners-api/uploadpublicexpense): POST /public/expenses — Upload expense document - [Update expense](https://docs-staging.payme.io/keep-api-migrated/partners-api/updatepublicexpense): PATCH /public/expenses/{expenseId} — Update expense - [Update seller](https://docs-staging.payme.io/keep-api-migrated/partners-api/updatesellerbyid): PUT /public/sellers/{sellerId}/update — Update seller - [Get external URLs for seller](https://docs-staging.payme.io/keep-api-migrated/partners-api/getsellerexternalurls): GET /partner/api/sellers/external-urls — Get external URLs for seller - [Get finance profile URL](https://docs-staging.payme.io/keep-api-migrated/partners-api/getsellerfinanceprofile): GET /partner/api/sellers/finance-profile — Get finance profile URL - [Set seller billing plan](https://docs-staging.payme.io/keep-api-migrated/partners-api/setsellerplan): POST /partner/api/sellers/set-plan — Set seller billing plan - [Create seller comment](https://docs-staging.payme.io/keep-api-migrated/partners-api/createsellercomment): POST /partner/api/sellers/comment — Create seller comment - [List income documents](https://docs-staging.payme.io/keep-api-migrated/partners-api/listincomedocuments): GET /partner/api/documents/income — List income documents - [Create manual income document](https://docs-staging.payme.io/keep-api-migrated/partners-api/createmanualincomedocument): POST /partner/api/documents/income/manual — Create manual income document - [Setup tax authority for seller](https://docs-staging.payme.io/keep-api-migrated/partners-api/setuptaxauthority): POST /partner/api/tax-authority/setup — Setup tax authority for seller - [Set VAT balance](https://docs-staging.payme.io/keep-api-migrated/partners-api/setvatbalance): POST /partner/api/sellers/vat-balance — Set VAT balance - [Set tax balance](https://docs-staging.payme.io/keep-api-migrated/partners-api/settaxbalance): POST /partner/api/sellers/tax-balance — Set tax balance - [Get financial checkpoints](https://docs-staging.payme.io/keep-api-migrated/partners-api/getcheckpoints): GET /partner/api/statistic/checkpoints — Get financial checkpoints - [Get tax predictions](https://docs-staging.payme.io/keep-api-migrated/partners-api/gettaxpredictions): GET /partner/api/statistic/tax-predictions — Get tax predictions ## Products and Customers API reference for storing a seller's product catalogue and customer records: create, list, update and delete products and customers, authenticated with a JWT from `POST /auth/token`. ### Authentication - [Generate JWT Token](https://docs-staging.payme.io/products-and-customers-migrated/authentication/post-auth-token): POST /auth/token — Generate JWT Token - [Refresh JWT Token](https://docs-staging.payme.io/products-and-customers-migrated/authentication/post-auth-refresh): POST /auth/refresh — Refresh JWT Token ### Products - [Get Products](https://docs-staging.payme.io/products-and-customers-migrated/products/get-products): GET /products — Get Products - [Get by Product Guid](https://docs-staging.payme.io/products-and-customers-migrated/products/get-products-guid): GET /products/{guid} — Get by Product Guid - [Update Product](https://docs-staging.payme.io/products-and-customers-migrated/products/patch-products-product-id): PATCH /products/{guid} — Update Product - [Delete Product](https://docs-staging.payme.io/products-and-customers-migrated/products/delete-products-guid): DELETE /products/{guid} — Delete Product - [Create New Product](https://docs-staging.payme.io/products-and-customers-migrated/products/post-user): POST /products — Create New Product ### Customers - [Get Customers](https://docs-staging.payme.io/products-and-customers-migrated/customers/get-customers): GET /customers — Get Customers - [Create New Customer](https://docs-staging.payme.io/products-and-customers-migrated/customers/post-customers): POST /customers — Create New Customer - [Get by Customer Guid](https://docs-staging.payme.io/products-and-customers-migrated/customers/get-customers-guid): GET /customers/{guid} — Get by Customer Guid - [Update Customer](https://docs-staging.payme.io/products-and-customers-migrated/customers/patch-customers): PATCH /customers/{guid} — Update Customer - [Delete Customer](https://docs-staging.payme.io/products-and-customers-migrated/customers/delete-customers): DELETE /customers/{guid} — Delete Customer ## eCommerce ### Category 1 - [Page 1](https://docs-staging.payme.io/ecommerce/category-1/page-1)