{"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"}],"paths":{"/generate-sale":{"post":{"operationId":"post-generate-sale","summary":"Generate Payment","tags":["Hosted Payment Page"],"description":"\n## Overview\n\n\nThis endpoint can be used for the following actions:\n\nAction | Description\n----|----\nBasic Sale (J4) | Allows you to create a sale.\nAuthorization (J5)| The requested amount gets reserved (blocked) on the credit card of the buyer for up to 168 hours.\n\nYou can find more information in our [Capture Sale Guide](/marketplaces-and-platforms/payments/capture-sale).\nTemplate Payment Page | Enables many payments on a single sale link, by different buyers.\n\nYou can find more information in our [Template Payment Page Guide](/marketplaces-and-platforms/payments/multi-payment-page).\nCreate Payment With Buyer Key (Token)| Enables to capture token once the buyer pays (enter the payment details).\n\nYou can find more information in our [Create Payment With Buyer Key (Token) Guide](/marketplaces-and-platforms/payments/create-payment-with-buyer-key-token).\n\n\n**See the request example below.**\n\n* For all the sale types see [Sale Types](/marketplaces-and-platforms/lists-statuses/sale-types).\n* For all the payment methods see [Available Payment Methods](/payments/direct-api/available-payment-methods).\n\n\n#### Callbacks\nOnce the sale is paid successfully, we will notify the marketplace with the sale details with a POST of `type` `x-www-form-urlencoded` request to the marketplace Callback URL. \n\nYou can find the sale callback attributes [Sale Callbacks](/marketplaces-and-platforms/lists-statuses/sale-callbacks).\n\n#### Issuing an Invoice for a Business\nIn the case where you are connected to our invoices services, you can send the following parameters as a part of your `generate-sale` API request to us when paying using a Token (saved card) in our platform.\n\nPlease add the following parameters to your request:\nParameter Name|Parameter Type|Example & Limitations\n--|--|--\n`buyer_business_name`| `string` | The name of the business the invoice should be issued for.\n`buyer_business_code` | `integer` | The business code (VAT identifier) of the company the invoice is issued for. \n\n#### Multi Payment Methods Checkout Page\nTo allow the buyer to select the payment method by himself, use `sale_payment_method=\"multi\"`.\n\nIt will show your available payment methods (based on the added services in your account) in one payment page: Credit card, bit, ApplePay and GooglePay.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"sale_price":{"type":"number","description":"Sale final price.\n\nFor example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075.\n\nNote that the minimum value is 500."},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"product_name":{"type":"string","description":"Short name and description of the product/service.\n\nThis text will be shown in the invoice as well, if the seller has enabled the invoices module in his account panel.\n\nLimited to 500 characters"},"transaction_id":{"type":"string","description":"Merchant's unique sale ID for correlation with us"},"installments":{"type":"string","description":"Amount of installments for the sale.\nWe allow you to manually set the number of installments or to specify a top limit of installments for the buyer to choose from while paying.\n\nSetting a fixed number of installments is simply entering a number between 1 and 12.\n\nThe sale will be initiated with this number of installments and the buyer will not be able to change it.\n\nTo set a range for the buyer to choose from, enter the following:\n\n`103` - allow up to 3 installments\n\n`106` - allow up to 6 installments\n\n`109` - allow up to 9 installments\n\n`112` - allow up to 12 installments"},"market_fee":{"type":"number","description":"A decimal representing the percent of the sale price that is collected for the marketplace (includes VAT).\n\nThis fee is added on top of our fees and transferred to the marketplace once a month.\n\nDefault value is the market fee of the Seller, as set upon Seller creation."},"sale_send_notification":{"type":"boolean","description":"Flag to send email and/or SMS notifications"},"sale_callback_url":{"type":"string","description":"Callback response to your page regarding call to our API. Default value is taken from the Merchant's settings. Note that you may not send a \"localhost\" URL as value"},"sale_email":{"type":"string","description":"In case sale send notification is true provide the address to send email notification"},"sale_return_url":{"type":"string","description":"We will redirect the IFRAME and the buyer to this URL upon payment success. Default value is taken from the Merchant's settings"},"sale_mobile":{"type":"string","description":"In case sale send notification is true, provide the phone number to send SMS notification, if the seller has enabled the SMS module in his account panel"},"sale_name":{"type":"string","description":"The name that will be displayed when sending a notification"},"capture_buyer":{"type":"string","description":"Flag for requesting the buyer's token for this payment (0 - do not capture token, 1 - capture token). For additional information see Tokens explanation below"},"buyer_perform_validation":{"type":"string","description":"Flag for performing an online validation of the card with the Issuer."},"sale_type":{"type":"string","description":"You can find all the sale types [Sale Types](/marketplaces-and-platforms/lists-statuses/sale-types)."},"sale_payment_method":{"type":"string","description":"the Payment method used to pay the sale.\n\nFor all the payment methods see [Available Payment Methods](/payments/direct-api/available-payment-methods).\n\nTo display multi payment methods use `multi`."},"layout":{"type":"string","description":"IFRAME payment page layout. Optional attribute which may be used with \"bit\" sale_payment_method. Avai lable layouts are:dynamic, qr-sms or dynamic-loose \ndynamic loose removes the validation for the social ID and CVV."},"language":{"type":"string","description":"Changes the language of the payment IFRAME to English, as well as the error messages. Default value is Hebrew (he)"},"order_number":{"type":"string","description":"Purchase Order Number. Mandatory for level 2 / 3 card data.\nMaximum length: 15 digits"},"items":{"type":"array","description":"This is an object that should include multiple arrays. An array for each product (item) that is a part of this sale.\nAll parameters that are numeric or integer must be equal or more than 0.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Item\nMinimum length: 1 Character\nMaximum length: 50 Characters"},"quantity":{"type":"integer","description":"Number of items,\nMinimum length: 0 digits,\nMaximum length: 6 digits"},"unit_price":{"type":"integer","description":"Price of single unit in pennies,\nNo length limitations"},"unit_measurement":{"type":"string","description":"Unit of measurment,\nMinimum length: 0 characters (nullable),\nMaximum length: 12 characters"},"total":{"type":"integer","description":"Total Price After Discount,\nMinimum length: 0 digits,\nMaximum length: 10 digits"},"discount_total":{"type":"number","description":"In negative pennies amount,\nMinimum length: 0 digits (nullable),\nMaximum length: 12 digits"},"description":{"type":"string","description":"The item description,\nMinimum length: 0 characters (nullable,\nMaximum length: 150 characters"},"product_code":{"type":"string","description":"The item catalog code.\nMinimum length: 0 characters (nullable),\nMaximum length: 100 characters"},"commodity_code":{"type":"number","description":"The item's commodity code,\nMinimum length: 0 digits (nullable),\nMaximum length: unlimited"}}}},"fees":{"type":"object","description":"Amount of tax in pennies\nNo length ","properties":{"tax":{"type":"number","description":"The tax collected as a part of the payment - In pennies,\nMinimum length: 0,\nMaximum Length: 12 Digits"},"duty":{"type":"number","description":"The international fees collected as a part of the payment - In pennies,\nMinimum lenth: 0,\nMaximum Length: 12 Digits"},"discount":{"type":"number","description":"The total discount given for the payment - In pennies,\nMinimum length: 0,\nMaximum Length: 12 Digits"},"shipping":{"type":"number","description":"The shipping cost charged as a part of the payment - In pennies,\nMinimum lenth: 0,\nMaximum Length: 12 Digits"}}},"shipping_details":{"type":"object","properties":{"name":{"type":"string","description":"Individual's full name/Company's name,\nMaximum Length: 50 Characters"},"email":{"type":"string","description":"Email address of the addressee,\nMaximum Length: 100 Characters"},"phone":{"type":"string","description":"Phone number of the addressee,\nMaximum Length: 50 Characters"},"address":{"type":"object","description":"Address Object","properties":{"line1":{"type":"string","description":"Line 1 of the shipping address,\nNo Limits."},"line2":{"type":"string","description":"Line 1 of the shipping address,\nNo Limits."},"postal_code":{"type":"string","description":"Postal code of the shipping address,\nNo Limits."},"city":{"type":"string","description":"City of the shipping address,\nNo Limits."},"state":{"type":"string","description":"State of the shipping address,\nNo Limits."},"country":{"type":"string","description":"Country of the shipping address,\nNo Limits."}}}}},"billing_details":{"type":"object","properties":{"name":{"type":"string","description":"Individual's full name/Company's name,\nNo Limits."},"email":{"type":"string","description":"Email address of the payer,\nNo Limits."},"phone":{"type":"string","description":"Phone number of the payer,\nNo Limits."},"address":{"type":"object","properties":{"line1":{"type":"string","description":"Line 1 of the billing address,\nNo Limits."},"line2":{"type":"string","description":"Line 2 of the billing address,\nNo Limits."},"postal_code":{"type":"string","description":"Postal code of the billing address\nNo Limits."},"city":{"type":"string","description":"City of the billing address,\nNo Limits."},"state":{"type":"string","description":"State of the shipping address,\nNo Limits."},"country":{"type":"string","description":"Country of the billing address,\nNo Limits."}}}}},"buyer_name":{"type":"string","description":"Buyer's name"},"buyer_email":{"type":"string","description":"Buyer's email"},"buyer_phone":{"type":"string","description":"Buyer's phone"}},"required":["seller_payme_id","sale_price","currency","product_name"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sale_price":1000,"currency":"ILS","product_name":"Smartphone","transaction_id":"12345","installments":"1","market_fee":0.5,"sale_send_notification":true,"sale_callback_url":"https://www.payme.io","sale_email":"test@payme.io","sale_return_url":"https://www.payme.io","sale_mobile":"+9725254448888","sale_name":"Test User","capture_buyer":"0","buyer_perform_validation":false,"sale_type":"sale","sale_payment_method":"credit-card","language":"he"}}}},"responses":{"200":{"description":"Sale Created Successfully","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"},"sale_url":{"type":"string","description":"The URL of the IFRAME secured payment form to display to the buyer"},"payme_sale_id":{"type":"string","description":"Our unique sale ID"},"payme_sale_code":{"type":"number","description":"Our unique sale code (for display purposes only)"},"price":{"type":"number","description":"Sale final price. For example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075"},"transaction_id":{"type":"string","description":"Merchant's unique sale ID for correlation with us"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."}}},"example":{"status_code":0,"sale_url":"https://preprod.paymeservice.com/sale/generate/XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_code":12345678,"price":10000,"transaction_id":"12345","currency":"USD"}}}},"500":{"description":"Missing Required Information","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":1,"status_error_details":"קישור משתמש לא נמצא","status_additional_info":null,"status_error_code":251}}}}}}},"/pay-sale":{"post":{"operationId":"post-pay-sale","summary":"Pay Sale","tags":["Direct API"],"description":"## Overview\n\n**This endpoint can be used only if you are using our Direct Integration method.**\n\nThis endpoint allows you to pay on a sale you created.\n\n\nBy sending this request, a few actions occur: the sale is processed, the buyer is charged, and you receive an asynchronous response with the sale data.\n\nYou can find more information in the following guide - [Direct API - How to create and pay sale](/marketplaces-and-platforms/integrations/direct-api-how-to-create-and-pay-sale).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID\n"},"sale_price":{"type":"string","description":"Sale final price. For example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075. Note that the minimum value is 500.\n"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"installments":{"type":"string","description":"Amount of installments for the sale."},"language":{"type":"string","description":"The language of the response and callback."},"sale_callback_url":{"type":"string","description":"Callback response to your page regarding call to our API. Default value is taken from the Merchant's settings. Note that you may not send a \"localhost\" URL as value"},"sale_return_url":{"type":"string","description":"Once the payment was completed successfully, the user will be redirected to this URL"},"capture_buyer":{"type":"number","description":"Flag for requesting the buyer's token for this payment (0 - do not capture token, 1 - capture token). For additional information see Tokens explanation below"},"buyer_key":{"type":"string","description":"Buyer key for an instant-payment with the token. This key is received through the use of capture_buyer. Note that this attribute cannot co-exist with the capture_buyer parameter in the same request"},"payme_sale_id":{"type":"string","description":"Our unique sale ID"},"credit_card_number":{"type":"number","description":"The card the transaction will be paid with."},"credit_card_exp":{"type":"string","description":"The expiration date of the card used to pay for the transaction (MM/YY)"},"credit_card_cvv":{"type":"string","description":"The CVV of the card used to pay for the transaction. (3/4 digit code)"}},"required":["seller_payme_id","sale_price","currency","installments","sale_return_url","buyer_key","payme_sale_id","credit_card_number","credit_card_exp","credit_card_cvv"]},"example":{"seller_payme_id":"string","sale_price":"string","currency":"string","installments":"string","sale_return_url":"string","capture_buyer":0,"buyer_key":"string","payme_sale_id":"string","credit_card_number":0,"credit_card_exp":"string","credit_card_cvv":0}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the capture request (0 - success, 1 - error)"},"payme_status":{"type":"string","description":"PayMe's payment status (success/failure)"},"payme_sale_id":{"type":"string","description":"PayMe's unique Sale ID"},"payme_sale_code":{"type":"number","description":"PayMe's unique Sale code"},"sale_created":{"type":"string","description":"The date the sale was created (timestamp)"},"payme_sale_status":{"type":"string","description":"PayMe's sale status"},"sale_status":{"type":"string","description":"Sale status"},"currency":{"type":"string","description":"Sale currency. 3-letter ISO 4217 name"},"transaction_id":{"type":"string","description":"Transaction ID"},"is_token_sale":{"type":"boolean","description":"Was the card tokenized or not"},"price":{"type":"number","description":"Payment price"},"payme_signature":{"type":"string","description":"PayMe's signature for the payment"},"payme_transaction_id":{"type":"string","description":"PayMe transaction ID"},"payme_transaction_total":{"type":"string","description":"Transaction total amount"},"payme_transaction_card_brand":{"type":"string","description":"The card brand "},"payme_transaction_auth_number":{"type":"string","description":"Transaction authorization number"},"payme_transaction_voucher":{"type":"string","description":"PayMe's transaction voucher"},"buyer_name":{"type":"string","description":"Buyer's full name"},"buyer_email":{"type":"string","description":"Buyer's email address"},"buyer_phone":{"type":"string","description":"Buyer's phone number"},"buyer_card_mask":{"type":"string","description":"Card mask"},"buyer_card_exp":{"type":"string","description":"Buyer's card expiration date"},"buyer_card_is_foreign":{"type":"boolean","description":"Is the card foreign or domestic? \n(For IL Sellers only)"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number"},"installments":{"type":"number","description":"Number of installments used for the payment"},"sale_paid_date":{"type":"string","description":"Sale paid date"}}},"example":{"status_code":0,"redirect_url":null,"payme_status":"string","status_error_code":0,"payme_sale_id":"string","payme_sale_code":0,"sale_created":"string","payme_sale_status":"string","sale_status":"string","currency":"string","transaction_id":"string","is_token_sale":true,"price":0,"payme_signature":"string","payme_transaction_id":"string","payme_transaction_total":"string","payme_transaction_card_brand":"string","payme_transaction_auth_number":"string","payme_transaction_voucher":"string","buyer_name":"string","buyer_email":"string","buyer_phone":null,"buyer_card_mask":"string","buyer_card_exp":"string","buyer_card_is_foreign":true,"buyer_social_id":null,"installments":0,"sale_paid_date":"string","sale_release_date":null}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":0,"status_error_details":"string","status_additional_info":"string","status_error_code":0}}}}}}},"/vas-enable":{"post":{"operationId":"post-vas-enable","summary":"Order New POS Device","tags":["Point of Sale (POS)"],"description":"## Overview\n\nIn order to be initiate the process of receiving a physical Point Of Sale (POS) device, you will first need to generate a new request to `https://<env>.payme.io/api/vas-enable` using your personal VAS identifier.\n\nOnce the VAS is activated, the process will be initiated and the following operations will take place:\n\n1. New terminal request (takes up to 5 business days)\n2. Physical device internal preparation (Immediate once terminal is ready)\n\nThe API request for activating the service will look as follows:\n### 1st step\nAdd the payment method via `vas-enable`\n```\n{\n    \"payme_client_key\": \"payme_client_key\",\n    \"seller_payme_id\": \"seller_payme_id\",\n    \"vas_payme_id\": \"vas_payme_id\"\n}\n```\n\n### 2nd step\nAdd the device type via `vas-enable`\n```\n{\n \"payme_client_key\": \"payme\",\n \"seller_payme_id\":\"MPL15991-MPL15991-MPL15991-MPL15991\",\n \"vas_payme_id\": \"VASL1545-8192915E-8192915E-8192915E\",\n \"extend_items\": true,\n \"vas_data\": {\n              \"number_of_devices\": 3,\n              \"items\":[\n                        {\n                          \"pos_id\": \"123\", \n                          \"shipping_address\": \"address of shipping\", \n                          \"name\": \"name of the device\"\n                        },\n                        {\n                        \"pos_id\": \"123\", \n                          \"shipping_address\": \"address of shipping\", \n                          \"name\": \"name of the device\"   \n                        }\n                      ]\n            }\n}\n```\n\nOnce the VAS is activated, the process will be synchronous and there's no further action required to be completed by the partner or seller until receiving the device and starting to process immidiately. \n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"The PayMe Secret Client Key"},"seller_payme_id":{"type":"string","description":"The unique seller identifier (MPL)."},"vas_payme_id":{"type":"string","description":"The unique activation key."},"vas_data":{"type":"object","description":"The predefined data object that allows you to request specific device amount and a per device information.","properties":{"number_of_devices":{"type":"integer","description":"The number of requested devices."},"items":{"type":"array","description":"The devices array. The items count must be equal to `number_of_devices` value.","items":{"type":"object","properties":{"pos_id":{"type":"string","description":"The unique POS ID. This ID will be used in order to send payment request to the specific device."},"shipping_address":{"type":"string","description":"The shipping address for the physical device."},"name":{"type":"string","description":"The name of the device. Will be used internally for the setup process."}},"required":["pos_id","shipping_address","name"]}}},"required":["number_of_devices","items"]},"extend_items":{"type":"boolean"}},"required":["payme_client_key","seller_payme_id","vas_payme_id","vas_data","extend_items"]},"example":{"payme_client_key":"icount","seller_payme_id":"MPL90009-90009EXM-EXAMPLE0-EXAMPLE9","vas_payme_id":"VASL1545-8192915E-5NTSEUM1-03YNFWNU","vas_data":{"number_of_devices":3,"items":[{"pos_id":"123","shipping_address":"address of shipping","name":"name of the device"},{"pos_id":"123","shipping_address":"address of shipping","name":"name of the device"}]}}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string","description":"The status code."},"seller_payme_id":{"type":"string","description":"The unique seller ID."},"message":{"type":"string","description":"The message for either success of failure."}}},"example":{"status_code":2,"seller_payme_id":"MPL00010-00010EXM-EXAMPLE0-EXAMPLE0","message":"Zendesk ticket created"}}}}}}},"/vas/pos/pair":{"post":{"operationId":"post-pair","summary":"Pair New Device","tags":["Point of Sale (POS)"],"description":"## Overview\n\nThis method is used to pair a stand-alone terminal to a POS/ECR. Each stand-alone terminal has a unique ID that is used in the paring process, this method is called first and then the pairing process is finalized by calling the authenticate method. Target URLs\n\n\nAs a part of the pairing process, the devices will be numbered automatically - The first device - 001 and onwards.\n\nWhen initiating a payment request, you will need to use this identifier and mention it as a part of the API endpoint `sales` request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your private API Key"},"seller_payme_id":{"type":"string","description":"Your Merchant's unique ID in our system"},"pos_id":{"type":"string","description":"The ID you must choose for your POS. Must be a string of digits, between \"001\" and \"999\""},"terminal_id":{"type":"string","description":"A unique payment terminal identifier, this ID is displayed on the POS in the pairing process\n\n"},"name":{"type":"string","description":"The name of the POS, this will be displayed on the devices screen. Usually this is the Merchant's name\n\n"}},"required":["payme_client_key","seller_payme_id","pos_id","terminal_id"]},"example":{"payme_client_key":"partner_key","seller_payme_id":"MPLXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","pos_id":"001","terminal_id":"9000015000","name":"John Doe"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0: success, otherwise error)\n\n"}}},"example":{"status_code":0}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0: success, otherwise error)\n\n"},"status_error_details":{"type":"string","description":"Error message to the client\n\n"},"status_additional_info":{"type":"string","description":"Additional error information\n\n"},"status_error_code":{"type":"number","description":"Our unique error code\n\n"}}},"example":{"status_code":1,"status_error_details":"Wrong terminalID","status_additional_info":null,"status_error_code":-1001}}}}}}},"/vas/pos/authenticate":{"post":{"operationId":"post-authenticate","summary":"Authenticate New Device","tags":["Point of Sale (POS)"],"description":"## Overview\n\nThis method completes the pairing process started with the pair method.\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your private API Key"},"seller_payme_id":{"type":"string","description":"Your Merchant's unique ID in our system"},"pos_id":{"type":"string","description":"The ID you must choose for your POS. Must be a string of digits, between \"001\" and \"999\""},"terminal_id":{"type":"string","description":"A unique payment terminal identifier, this ID is displayed on the POS in the pairing process"},"verification_code":{"type":"string","description":"OTP as displayed on the POS device"}},"required":["payme_client_key","seller_payme_id","pos_id","terminal_id"]},"example":{"payme_client_key":"partner_key","seller_payme_id":"MPLXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","pos_id":"001","terminal_id":"9000015000","verification_code":"123987"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success"}}}},"/sales":{"post":{"operationId":"post-payment","summary":"New POS Payment","tags":["Point of Sale (POS)"],"description":"## Overview\n\nCalling this method will \"push\" a payment request to the POS, synchronously awaiting the payment result. \n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"PayMe's unqiue seller ID"},"product_name":{"type":"string","description":"Product's description"},"sale_price":{"type":"number","description":"Sale Price"},"sale_type":{"type":"string","description":"You can find all the sale types [Sale Types](/marketplaces-and-platforms/lists-statuses/sale-types)."},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"transaction_id":{"type":"string","description":"Transaction ID"},"sale_callback_url":{"type":"string","description":"Sale Callback URL"},"payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method"},"pos_id":{"type":"string","description":"The ID you must choose for your POS. Must be a string of digits, between \"001\" and \"999\""}},"required":["method","pos_id"]},"customer":{"type":"object","description":"The customer object is **not** mandatory.\n**If this object is added** to the request, it should include its **required fields**: name, email and phone.","properties":{"name":{"type":"string","description":"Customer name"},"email":{"type":"string","description":"Customer email"},"zip_code":{"type":"string","description":"Customer address zip code"},"phone":{"type":"string","description":"Customer mobile phone number"},"social_id":{"type":"string","description":"Customer social ID / national ID for additional verification"}}},"language":{"type":"string","description":"Customer language"}},"required":["seller_payme_id","product_name","sale_price","transaction_id","sale_callback_url","payment"]},"example":{"seller_payme_id":"MPLXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","product_name":"My Product","sale_price":10000,"currency":"USD","transaction_id":"12345","sale_callback_url":"https://www.example.com/payment/callback","payment":{"method":"emv","pos_id":"001"},"customer":{"name":"John Due","email":"test@test.com","phone":"+498963648018"},"language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"PayMe's payment status (success/failure)"},"payme_status":{"type":"string","description":"PayMe's payment status (success/failure)"},"payme_sale_id":{"type":"string","description":"PayMe's unique Sale ID\r\n\r\n"},"payme_sale_code":{"type":"integer","description":"PayMe's unique Sale code\r\n\r\n"},"sale_created":{"type":"string","description":"The date the sale was created (timestamp)\r\n\r\n"},"payme_sale_status":{"type":"string","description":"PayMe's sale status\r\n\r\n"},"sale_status":{"type":"string","description":"Sale status\r\n\r\n"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"transaction_id":{"type":"string","description":"Transaction ID\r\n\r\n"},"is_token_sale":{"type":"boolean","description":"Was the card tokenized or not\r\n\r\n"},"price":{"type":"integer","description":"Payment price\r\n\r\n"},"payme_signature":{"type":"string","description":"PayMe's signature for the payment\r\n\r\n"},"sale_description":{"type":"string","description":"Sale description"},"payme_transaction_id":{"type":"string","description":"PayMe transaction ID\r\n\r\n"},"payme_transaction_total":{"type":"string","description":"Transaction total amount\r\n\r\n"},"payme_transaction_card_brand":{"type":"string","description":"The card brand\r\n\r\n"},"payme_transaction_auth_number":{"type":"string","description":"Transaction authorization number\r\n\r\n"},"buyer_name":{"type":"string","description":"Buyer's full name\r\n\r\n"},"buyer_email":{"type":"string","description":"Buyer's email address\r\n\r\n"},"buyer_phone":{"type":"string","description":"Buyer's phone number\r\n\r\n"},"buyer_card_mask":{"type":"string","description":"Card mask\r\n\r\n"},"buyer_card_exp":{"type":"string","description":"Buyer's card expiration date\r\n\r\n"},"buyer_card_is_foreign":{"type":"boolean","description":"Is the card foreign or domestic? (For IL Sellers only)\r\n\r\n"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number\r\n\r\n"},"installments":{"type":"integer","description":"Number of installments used for the payment\r\n\r\n"},"sale_paid_date":{"type":"string","description":"Sale paid date\r\n\r\n"}}},"example":{"status_code":0,"payme_status":"success","status_error_code":0,"payme_sale_id":"SALE1688-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_code":12346578,"sale_created":"2023-06-29 13:33:54","payme_sale_status":"authorized","sale_status":"authorized","currency":"ILS","transaction_id":"string","is_token_sale":false,"price":100,"payme_signature":"db1c276**********c5b39","sale_description":"bbb","sale_deferred_months":null,"payme_transaction_id":"TRAN1688-034834SZ-OYNALKNE-DWOXFEUZ","payme_transaction_total":"100","payme_transaction_card_brand":"Mastercard","payme_transaction_auth_number":"12345678","payme_transaction_voucher":null,"payme_transaction_emv_uid":"2306**********102613","payme_transaction_acquirer":"PayMe","payme_transaction_auth_source":"CreditCompany","payme_transaction_card_issuer":"Isracard","payme_transaction_credit_type":"RegularCredit","buyer_name":"First Name","buyer_email":"test@example.com","buyer_phone":"+15417543010","buyer_card_mask":"532610******5846","buyer_card_exp":"0426","buyer_card_is_foreign":false,"buyer_social_id":"123456782","installments":1,"transaction_first_payment":"100","transaction_periodical_payment":0,"transaction_arn":"2306**********2613","sale_paid_date":"2023-06-29 13:33:54","sale_release_date":null,"sale_3ds":false,"redirect_url":null}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)\n\n"},"status_error_details":{"type":"string","description":"Error message\n\n"},"status_additional_info":{"type":"string","description":"Additional error information\n\n"},"status_error_code":{"type":"number","description":"Our unique error code\n\n"}}},"example":{"status_code":1,"status_error_details":"קישור משתמש לא נמצא","status_additional_info":null,"status_error_code":251}}}}}},"put":{"operationId":"put-sales","summary":"Refund POS Sale","tags":["Point of Sale (POS)"],"description":"In order to refund a sale paid via a POS device, you can use PUT function which will trigger a manual refund request sent back to the device.\n\n### You will need to chain the sale GUID unique identifier to the endpoint URL in the following form:\n`https://<env>.payme.io/api/sales/{sale_guid}` \n\n#### Example:\n\n`https://<env>.payme.io/api/sales/SALEGUID-TEST123-TEST123-TEST123` \n\nThe request will trigger a refund that will be sent to the designated device per the device ID mentioned in the request (see request example below)","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"PayMe's unqiue seller ID"},"product_name":{"type":"string","description":"Product's description"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"transaction_id":{"type":"string","description":"The external transaction ID."},"sale_callback_url":{"type":"string","description":"The callback url for the specific sale."},"payment":{"type":"object","description":"The payment object.","properties":{"method":{"type":"string","description":"The payment method."},"pos_id":{"type":"string","description":"The POS ID - the device that will be used to process the refund request."},"action":{"type":"string","description":"The action - must be `refund` in order to complete this action. "},"amount":{"type":"string","description":"The sale amount in Agorot"}}},"language":{"type":"string","description":"The language of the customer's interface. "}}},"example":{"seller_payme_id":"string","sale_price":0,"currency":"USD","payment":{"method":"pos","pos_id":"002","action":"refund"},"customer":{"name":"string","email":"string","phone":"string","zip_code":"string","social_id":"string"},"language":"he"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"PayMe's payment status (success/failure)\r\n\r\n"},"payme_status":{"type":"string","description":"Sale status\r\n\r\n"},"payme_sale_id":{"type":"string","description":"PayMe's unique Sale ID\r\n\r\n"},"payme_sale_code":{"type":"integer","description":"PayMe's unique Sale code\r\n\r\n"},"sale_created":{"type":"string","description":"The date the sale was created (timestamp)\r\n\r\n"},"payme_sale_status":{"type":"string","description":"PayMe's sale status\r\n\r\n"},"sale_status":{"type":"string","description":"Sale status\r\n\r\n"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217).\r\n"},"transaction_id":{"type":"string","description":"Transaction ID\r\n\r\n"},"is_token_sale":{"type":"boolean","description":"Was the card tokenized or not\r\n\r\n"},"price":{"type":"integer","description":"Payment price\r\n\r\n"},"payme_signature":{"type":"string","description":"PayMe's signature for the payment\r\n\r\n"},"sale_description":{"type":"string","description":"Sale description\r\n\r\n"},"payme_transaction_id":{"type":"string","description":"PayMe transaction ID\r\n\r\n\r\n"},"payme_transaction_total":{"type":"string","description":"Transaction total amount\r\n\r\n\r\n"},"payme_transaction_card_brand":{"type":"string","description":"The card brand\r\n\r\n\r\n"},"payme_transaction_auth_number":{"type":"string","description":"Transaction authorization number\r\n\r\n\r\n"},"buyer_name":{"type":"string","description":"Buyer's full name\r\n\r\n"},"buyer_email":{"type":"string","description":"Buyer's email address\r\n\r\n"},"buyer_phone":{"type":"string","description":"Buyer's phone number\r\n\r\n"},"buyer_card_mask":{"type":"string","description":"Card mask\r\n\r\n"},"buyer_card_exp":{"type":"string","description":"Buyer's card expiration date\r\n\r\n"},"buyer_card_is_foreign":{"type":"boolean","description":"Is the card foreign or domestic? (For IL Sellers only)\r\n\r\n"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number\r\n\r\n"},"installments":{"type":"integer","description":"Number of installments used for the payment\r\n\r\n"},"sale_paid_date":{"type":"string","description":"Sale paid date\r\n\r\n"}}},"example":{"status_code":0,"payme_status":"success","status_error_code":0,"payme_sale_id":"SALE1688-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_code":12346578,"sale_created":"2023-06-29 13:33:54","payme_sale_status":"authorized","sale_status":"authorized","currency":"ILS","transaction_id":"string","is_token_sale":false,"price":100,"payme_signature":"db1c276**********c5b39","sale_description":"bbb","sale_deferred_months":null,"payme_transaction_id":"TRAN1688-034834SZ-OYNALKNE-DWOXFEUZ","payme_transaction_total":"100","payme_transaction_card_brand":"Mastercard","payme_transaction_auth_number":"12345678","payme_transaction_voucher":null,"payme_transaction_emv_uid":"2306**********102613","payme_transaction_acquirer":"PayMe","payme_transaction_auth_source":"CreditCompany","payme_transaction_card_issuer":"Isracard","payme_transaction_credit_type":"RegularCredit","buyer_name":"First Name","buyer_email":"test@example.com","buyer_phone":"+15417543010","buyer_card_mask":"532610******5846","buyer_card_exp":"0426","buyer_card_is_foreign":false,"buyer_social_id":"123456782","installments":1,"transaction_first_payment":"100","transaction_periodical_payment":0,"transaction_arn":"2306**********2613","sale_paid_date":"2023-06-29 13:33:54","sale_release_date":null,"sale_3ds":false,"redirect_url":null}}}}}}},"/refund-sale":{"post":{"operationId":"post-refund-sale","summary":"Refund Sale","tags":["Post Sale Actions"],"description":"## Overview\n\nRefund request enable you to reimburse a charge that was previously generated but remains unreimbursed. The funds will be returned to the initial payment method used for the charge.\n\n### Callback\nOnce the sale is refunded successfully, we will update the marketplace with the sale details with a POST request of type `x-www-form-urlencoded` to the marketplace Callback URL.\n\n#### Note:\nYou can refund multiple times per sale as long as you do not exceed the total amount of the sale. \nIf you do not send the `sale_refund_amount' parameter, the sale will be fully refunded.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe partner key. Only partners (platforms managing many sellers) have one; a merchant authenticates with seller_payme_id alone. Can also be sent in the PayMe-Partner-Key header."},"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"payme_sale_id":{"type":"string","description":"Our unique sale ID."},"sale_refund_amount":{"type":"integer","description":"**Used only for partial refunds**, for a full refund exclude this attribute.\n\nFor example:\n\nif the amount is 50.75 (max 2 decimal points) the value that recieved is 5075.\r\n\n\nNote that the minimum value is 500."},"language":{"type":"string","description":"Changes the error message language to English."}},"required":["seller_payme_id","payme_sale_id"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_id":"SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","sale_refund_amount":1000,"language":"he"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)."},"status_error_code":{"type":"integer","description":"Our unique error code.\r\n\r\n"},"payme_status":{"type":"string","description":"Status of the request (success, error)"},"refunded_from_creditcard":{"type":"boolean","description":"Return true if seller has not enough money for refund and we complete the refund from the seller credit card."},"sale_invoice_number":{"type":"integer","description":"Sale invoice Number."},"sale_invoice_url":{"type":"string","description":"Sale invoice URL, if the seller has enabled the invoices module in his account panel."},"sale_refund_buffer":{"type":"integer","description":"The refund buffer of this sale."},"sale_status":{"type":"string","description":"Refund status."},"payme_transaction_total":{"type":"integer","description":"The refund amount that the buyer will get."},"payme_transaction_total_aft_deduction":{"type":"integer","description":"The amount that the seller will be charge on."},"payme_transaction_id":{"type":"string","description":"The transaction unique id."},"payme_transaction_card_brand":{"type":"string","description":"Card brand."},"payme_transaction_auth_number":{"type":"string","description":"Authorization number from credit company.\r\n"},"payme_transaction_voucher":{"type":"string","description":"Transaction voucher"},"payme_signature":{"type":"string","description":"MD5 Signature"},"payme_transaction_acquirer":{"type":"string","description":"Transaction acquirer"}}},"example":{"status_code":0,"status_error_code":0,"payme_status":"success","refunded_from_creditcard":false,"sale_invoice_number":null,"sale_invoice_url":null,"sale_refund_buffer":18800,"sale_status":"partial-refund","payme_transaction_total":1000,"payme_transaction_total_aft_deduction":1000,"payme_transaction_id":"TRANDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_transaction_card_brand":"XXXXXXXX","payme_transaction_auth_number":"72****4","payme_transaction_voucher":"24****9","payme_signature":"b71e**************ca5a","payme_transaction_arn":null}}}}}}},"/capture-sale":{"post":{"operationId":"post-capture-sale","summary":"Capture Sale","tags":["Post Sale Actions"],"description":"## Overview\n\nThis endpoint enable you to execute the sale after authorization (`generate-sale` with `sale_type` = \"authorize\").\n\nFor more information, go to the [Capture Sale (Authorization) Guide](/marketplaces-and-platforms/payments/capture-sale).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key."},"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"payme_sale_id":{"type":"string","description":"Our unique sale ID"}}},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_id":"SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)"},"payme_status":{"type":"string","description":"Status of the request (success, error)\r\n\r\n"},"payme_sale_id":{"type":"string","description":"Our unique sale ID."},"payme_sale_code":{"type":"integer","description":"Sale code"},"sale_created":{"type":"string","description":"The date the sale was created (timestamp)\r\n\r\n"},"payme_sale_status":{"type":"string","description":"Sale status. You can find all the sale statuses [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses)."},"sale_status":{"type":"string","description":"Sale status. You can find all the sale statuses [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses).\r\n\r\n"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"transaction_id":{"type":"string","description":"The transaction ID."},"is_token_sale":{"type":"boolean","description":"Indicates if the sale paid with token."},"price":{"type":"integer","description":"The sale price."},"payme_signature":{"type":"string","description":"PayMe's signature for the payment\r\n\r\n"},"sale_description":{"type":"string","description":"Sale description"},"payme_transaction_id":{"type":"string","description":"PayMe transaction ID\r\n\r\n"},"payme_transaction_total":{"type":"string","description":"Transaction total amount\r\n\r\n"},"payme_transaction_card_brand":{"type":"string","description":"The card brand\r\n\r\n"},"payme_transaction_auth_number":{"type":"string","description":"Transaction authorization number\r\n\r\n"},"buyer_name":{"type":"string","description":"Buyer's full name\r\n\r\n"},"buyer_email":{"type":"string","description":"Buyer's email address\r\n\r\n"},"buyer_phone":{"type":"string","description":"Buyer's phone number\r\n\r\n"},"buyer_card_mask":{"type":"string","description":"Card mask\r\n\r\n"},"buyer_card_exp":{"type":"string","description":"Buyer's card expiration date\r\n\r\n"},"buyer_card_is_foreign":{"type":"boolean","description":"Is the card foreign or domestic? (For IL Sellers only)\r\n\r\n"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number\r\n\r\n"},"installments":{"type":"integer","description":"Number of installments used for the payment\r\n\r\n"},"sale_paid_date":{"type":"string","description":"Sale paid date\r\n\r\n"}}},"example":{"status_code":0,"payme_status":"success","status_error_code":0,"payme_sale_id":"SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_code":1111111,"sale_created":"2023-06-22 14:01:47","payme_sale_status":"completed","sale_status":"completed","currency":"ILS","transaction_id":"12345","is_token_sale":false,"price":150000,"payme_signature":"93a1ca34ed43bc00c62b9f467c40be8e","sale_description":"Computer","sale_deferred_months":null,"payme_transaction_id":"TRANDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_transaction_total":"150000","payme_transaction_card_brand":"Mastercard","payme_transaction_auth_number":"8906759","payme_transaction_voucher":"111111","payme_transaction_emv_uid":null,"payme_transaction_acquirer":"PayMe","payme_transaction_auth_source":"VoiceMail","payme_transaction_card_issuer":"Isracard","payme_transaction_credit_type":"RegularCredit","buyer_name":"Test User","buyer_email":"test@payme.io","buyer_phone":"9725254448888","buyer_card_mask":"532610******5846","buyer_card_exp":"0426","buyer_card_is_foreign":false,"buyer_social_id":"123456789","installments":1,"transaction_first_payment":150000,"transaction_periodical_payment":0,"transaction_arn":null,"sale_paid_date":"2023-06-22 14:04:28","sale_release_date":null,"sale_3ds":false}}}}}}},"/cancel-template":{"post":{"operationId":"post-cancel-template","summary":"Cancel Multi Payment Page","tags":["Post Sale Actions"],"description":"## Overview\n\nThis endpoint enable you to cancle a Multi Payment Page.\n\nMulti Payment Page enables payments on a single sale link, by multiple buyers.\n\nYou can find more information in our [Multi Payment Page Guide](/marketplaces-and-platforms/payments/multi-payment-page).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"payme_sale_id":{"type":"string","description":"Our unique sale ID."}},"required":["seller_payme_id","payme_sale_id"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_sale_id":"SALEDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","sale_refund_amount":1000,"language":"he"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)."}}},"example":{"status_code":0,"status_error_code":0,"payme_status":"success","refunded_from_creditcard":false,"sale_invoice_number":null,"sale_invoice_url":null,"sale_refund_buffer":18800,"sale_status":"partial-refund","payme_transaction_total":1000,"payme_transaction_total_aft_deduction":1000,"payme_transaction_id":"TRANDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","payme_transaction_card_brand":"XXXXXXXX","payme_transaction_auth_number":"72****4","payme_transaction_voucher":"24****9","payme_signature":"b71e**************ca5a","payme_transaction_arn":null}}}},"251":{"description":"Seller not found","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)."},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"integer"},"session":{"type":"string"}}},"example":{"status_code":1,"status_error_details":"מוכר לא נמצא","status_additional_info":"seller_payme_id","status_error_code":251,"session":"MfH3Hc80"}}}},"305":{"description":"This operation cannot be completed due to an inappropriate sale status","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)."},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"integer"},"session":{"type":"string"}}},"example":{"status_code":1,"status_error_details":"לא ניתן להשלים פעולה זו עקב סטטוס מכירה לא מתאים","status_additional_info":"canceled","status_error_code":305,"session":"NGQ1QpYB"}}}}}}},"/generate-subscription":{"post":{"operationId":"post-generate-subscription","summary":"Generate","tags":["Subscriptions"],"description":"## Overview\n\nThis endpoint is used to generate new subscriptions.\nYou can find more information in our guide - [How to create a subscription\n](/marketplaces-and-platforms/payments/how-to-create-subscription).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key.\r\n\r\n"},"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"sub_currency":{"type":"string","description":"Subscription currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"sub_price":{"type":"string","description":"A single iteration final price.\n\nFor example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075. Note that the minimum value is 500"},"sub_description":{"type":"string","description":"The description of the service/product"},"sub_iteration_type":{"type":"string","description":"1 - Daily, 2 - Weekly, 3 - Monthly, 4 - Yearly"},"language":{"type":"string","description":"Changes the language of the payment IFRAME to English, as well as the error messages. Default value is Hebrew (he)"},"sub_start_date":{"type":"string","description":"Subscription initiation date.\n\nFor iteration type = 3 (monthly) the day value should be between 1 to 28"},"sub_payment_method":{"type":"string","description":"Sale Payment Method (for the list see [Payment Methods](/payments/direct-api/available-payment-methods))"},"sub_type":{"type":"number","description":"subscription type: 1-regular, 10-template"},"buyer_key":{"type":"string","description":"Buyer key for subscription payment with the token. Relevant only for sub_type = regular. \n\nThis key is received through the use of capture_buyer. \n\n \r\nNote that with this attribute no need to activate pay-subscription."},"subscription_id":{"type":"string","description":"Merchant's unique subscription ID for correlation with us"},"sub_iterations":{"type":"number","description":"The iterations count set for the subscription.\n\nDefault value is set to unlimited by -1 value."},"sub_callback_url":{"type":"string","description":"Callback response to your page regarding updates on subscription events."},"sub_return_url":{"type":"string","description":"Once the subscription was paid successfully, the user will be redirected to this URL\n\nRelevant to the first subscription iteration, if it is paid through our iframe."},"sub_indicative_name":{"type":"string","description":"Indicative name for the subscribition"},"sub_email_address":{"type":"string","description":"Email address of the subscription payer"},"sub_indicative_mobile":{"type":"string","description":"Phone number to send receipt"},"sub_send_notification":{"type":"boolean","description":"Indication if to send notifications on subscription events."}},"required":["payme_client_key","seller_payme_id","sub_currency","sub_price","sub_description","sub_iteration_type"]},"example":{"seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","sub_price":500,"sub_currency":"USD","sub_description":"Subscription for something","sub_iteration_type":"3","sub_iterations":12,"sub_start_date":"1440354488","sub_callback_url":"https://www.example.com/payment/callback","sub_return_url":"https://www.example.com/payment/success","buyer_key":"XXXXXXXX","language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"sub_url":{"type":"string","description":"Subscription Unique URL"},"status_code":{"type":"string","description":"Status code (0 - sucess, 1 - failed)"},"payme_status":{"type":"string","description":"PayMe updated status`"},"seller_payme_id":{"type":"string"},"seller_id":{"type":"string","description":"Our unique seller ID"},"sub_payme_id":{"type":"string","description":"PayMe's unique subscription ID"},"sub_payme_code":{"type":"string","description":"PayMe's subscription code"},"subscription_id":{"type":"string","description":"Subscription unique ID"},"sub_created":{"type":"string","description":"The date the subscription was created\n"},"sub_start_date":{"type":"string","description":"Subscription initiation date"},"sub_prev_date":{"type":"string","description":"Previous subscription payment date"},"sub_next_date":{"type":"string","description":"Subscription next payment due date"},"sub_status":{"type":"string","description":"Subscription status (0 - active, 1 - inactive)"},"sub_iteration_type":{"type":"string","description":"1 - Daily, 2 - Weekly, 3 - Monthly, 4 - Yearly"},"sub_currency":{"type":"string","description":"Subscription currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"sub_price":{"type":"string","description":"A single iteration final price.\n\nFor example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075. Note that the minimum value is 500"},"sub_description":{"type":"string","description":"Subscription description - What is the subscription for?"},"sub_iterations":{"type":"string","description":"The iterations count set for the subscription according to the request command\n"},"sub_iterations_completed":{"type":"number","description":"The number of iterations completed for the specific subscription"},"sub_iterations_left":{"type":"string","description":"Count of iteration left for the specific subscription"},"sub_paid":{"type":"boolean","description":"Was the subscription fully paid or not"},"status_error_code":{"type":"number","description":"Error code in case of an error"},"sub_error_text":{"type":"string","description":"Error description in case of an error"}}},"example":{"sub_url":"string","status_code":"0","payme_status":"string","status_error_code":"string","seller_payme_id":"string","seller_id":"string","sub_payme_id":"string","sub_payme_code":"string","subscription_id":"string","sub_created":"string","sub_start_date":"string","sub_prev_date":"string","sub_status":"string","sub_next_date":"string","sub_iteration_type":"string","sub_currency":"string","sub_price":"string","sub_description":"string","sub_iterations":"string","sub_iterations_completed":0,"sub_iterations_left":"string","sub_paid":true,"sub_error_text":"string"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code 1 (for failure)"},"status_error_details":{"type":"string","description":"What caused the error"},"status_additional_info":{"type":"string","description":"The parameters related to the error"},"status_error_code":{"type":"number","description":"Status error code - 1"}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"seller_payme_id","status_error_code":1}}}}}}},"/pay-subscription":{"post":{"operationId":"post-generate-subscription-2","summary":"Pay","tags":["Subscriptions"],"description":"## Overview\n\n**Relevant only for Direct API Integration**\n\nThis endpoint is used to pay subscriptions.\n\n**No API key is needed.** The subscription (`sub_payme_id`) identifies the seller, so — like pay-sale — this call can be made from the buyer's browser. Do not send `seller_payme_id` or `payme_client_key` here.\n\nOnly a subscription whose status is initial, failed or failed-retry can be paid; any other status returns error `305`.\nYou can find more information in our guide - [How to create a subscription\n](/marketplaces-and-platforms/payments/how-to-create-subscription).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sub_payme_id":{"type":"string","description":"Our unique subscription ID"},"credit_card_number":{"type":"string","description":"Buyer's credit card number"},"credit_card_cvv":{"type":"string","description":"Buyer's credit card CVV"},"credit_card_exp":{"type":"string","description":"Buyer's credit card expiary date"},"buyer_email":{"type":"string","description":"Buyer's email address"},"buyer_name":{"type":"string","description":"Buyer's full name"}},"required":["sub_payme_id","credit_card_number","credit_card_cvv","credit_card_exp","buyer_email","buyer_name"]},"example":{"sub_payme_id":"SUB16885-68336QPL-UQSSS1CC-SYKXI53N","credit_card_number":"4580458045804580","credit_card_cvv":"123","credit_card_exp":"0130","buyer_email":"user2@example.com","buyer_name":"sarit hadad"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Cancellation status code ( 0 - Success, 1 - Failure)"},"payme_status":{"type":"string","description":"PayMe status"},"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL)"},"sub_payme_id":{"type":"string","description":"Subscription ID"},"sub_payme_code":{"type":"integer","description":"Subscription code"},"sub_created":{"type":"string","description":"Subscription creation timestamp"},"sub_start_date":{"type":"string","description":"Subscription start timestamp"},"sub_prev_date":{"type":"string","description":"Subscription last payment date"},"sub_next_date":{"type":"string","description":"Subscription next payment date"},"sub_status":{"type":"integer","description":"You can find all the subscription statuses [Subscription Statuses](/marketplaces-and-platforms/lists-statuses/subscription-statuses)"},"sub_iteration_type":{"type":"integer","description":"You can find all the subscription iteration types [Subscription Iteration Types](/marketplaces-and-platforms/lists-statuses/subscription-iteration-types)\r\n\r\n"},"sub_currency":{"type":"string","description":"Subscription currency"},"sub_price":{"type":"integer","description":"Total subscription price"},"sub_description":{"type":"string","description":"Subscription description"},"sub_iterations":{"type":"integer","description":"Number of iterations"},"sub_iterations_completed":{"type":"integer","description":"Number of iterations that was paid"},"sub_iterations_skipped":{"type":"integer","description":"The count of unpaid iterations and their corresponding dates have elapsed."},"sub_iterations_left":{"type":"integer","description":"The count of iterations left"},"sub_paid":{"type":"boolean","description":"Indicates if the current iteration paid"},"sub_payment_date":{"type":"string","description":"The payment due date"},"buyer_card_mask":{"type":"string","description":"Buyer's credit card number"},"buyer_card_exp":{"type":"string","description":"Buyer's credit card expiary date"},"buyer_name":{"type":"string","description":"Buyer's full name"},"buyer_email":{"type":"string","description":"Buyer's email address"},"buyer_phone":{"type":"string","description":"Buyer's phone number"},"buyer_social_id":{"type":"string","description":"Buyer's social ID"}}},"example":{"status_code":0,"payme_status":"success","status_error_code":0,"seller_payme_id":"MPL90005-90005EXM-EXAMPLE0-EXAMPLE9","sub_payme_id":"SUB16885-68336QPL-UQSSS1CC-SYKXI53N","sub_payme_code":477004,"sub_created":"2023-07-05 17:45:36","sub_start_date":"2023-07-05 17:45:36","sub_prev_date":null,"sub_next_date":"2023-07-05 17:45:36","sub_status":2,"sub_iteration_type":1,"sub_currency":"USD","sub_price":100,"sub_description":"sub-description","sub_iterations":-1,"sub_iterations_completed":0,"sub_iterations_skipped":0,"sub_iterations_left":-1,"sub_paid":true,"sub_error_text":null,"sub_payment_date":"2022-08-15 15:51:29","buyer_card_mask":"458045******4580","buyer_card_exp":"0130","buyer_name":"Jhon Doe","buyer_email":"user3@example.com","buyer_phone":null,"buyer_social_id":null}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status code 1 (for failure)"},"status_error_details":{"type":"string","description":"What caused the error"},"status_additional_info":{"type":"string","description":"The parameters related to the error"},"status_error_code":{"type":"number","description":"Status error code - 1"}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"seller_payme_id","status_error_code":1}}}}}}},"/cancel-subscription":{"post":{"operationId":"postcancel-subscription","summary":"Cancel","tags":["Subscriptions"],"description":"## Overview\n\nThis endpoint is used to cancel existing subscriptions.\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"sub_payme_id":{"type":"string","description":"Our unique subscription ID"},"language":{"type":"string","description":"Changes the error message language to English. Default value is Hebrew (he)"}},"required":["seller_payme_id","sub_payme_id"]},"example":{"seller_payme_id":"string","sub_payme_id":"string"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string","description":"Cancellation status code ( 0 - Success, 1 - Failure)"}}},"example":{"status_code":"string"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string","description":"Cancellation status code ( 0 - Success, 1 - Failure)"}}},"example":{"status_code":"string"}}}}}}},"/pause-subscription":{"post":{"operationId":"post-pause-subscription","summary":"Pause","tags":["Subscriptions"],"description":"## Overview\n\n**Relevant only for Direct API Integration**\n\nThis endpoint is used to pause subscriptions.\nYou can find more information in our guide - [How to create a subscription\n](/marketplaces-and-platforms/payments/how-to-create-subscription).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"sub_payme_id":{"type":"string","description":"PayMe's unique subscription ID"}}},"example":{"seller_payme_id":"MPL00007-00007EXM-EXAMPLE0-EXAMPLE7","sub_payme_id":"SUB16999-507640UD-83RNQDGN-YHSXHXHG"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"payme_status":{"type":"string"},"status_error_code":{"type":"integer"},"seller_payme_id":{"type":"string"},"seller_id":{"type":"string"},"sub_payme_id":{"type":"string"},"sub_payme_code":{"type":"integer"},"subscription_id":{"type":"string"},"sub_created":{"type":"string"},"sub_start_date":{"type":"string"},"sub_prev_date":{"type":"string"},"sub_next_date":{"type":"string"},"sub_status":{"type":"integer"},"sub_iteration_type":{"type":"integer"},"sub_currency":{"type":"string"},"sub_price":{"type":"integer"},"sub_description":{"type":"string"},"sub_iterations":{"type":"integer"},"sub_iterations_completed":{"type":"integer"},"sub_iterations_skipped":{"type":"integer"},"sub_iterations_left":{"type":"integer"},"sub_paid":{"type":"boolean"},"sub_error_text":{"type":"string"},"sub_payment_date":{"type":"string"},"buyer_card_mask":{"type":"string"},"buyer_card_exp":{"type":"string"},"buyer_name":{"type":"string"},"buyer_email":{"type":"string"},"buyer_phone":{"type":"string"},"buyer_social_id":{"type":"string"}}},"example":{"status_code":0,"payme_status":"success","status_error_code":0,"seller_payme_id":"MPL00007-00007EXM-EXAMPLE0-EXAMPLE7","seller_id":null,"sub_payme_id":"SUB16999-507640UD-83RNQDGN-YHSXHXHG","sub_payme_code":343324,"subscription_id":null,"sub_created":"2023-11-14 10:32:44","sub_start_date":"2023-11-14 08:00:00","sub_prev_date":null,"sub_next_date":"2023-11-14 08:00:00","sub_status":3,"sub_iteration_type":1,"sub_currency":"ILS","sub_price":10000,"sub_description":"blablabla","sub_iterations":1,"sub_iterations_completed":0,"sub_iterations_skipped":0,"sub_iterations_left":1,"sub_paid":true,"sub_error_text":"הושהה על ידי המשתמש בתאריך 14/11/2023 10:33:35","sub_payment_date":"2023-10-31 14:23:49","buyer_card_mask":"532610******5846","buyer_card_exp":"0426","buyer_name":"Ran Tester","buyer_email":"TestTest@paymeservice.com","buyer_phone":"05222222","buyer_social_id":"123456789"}}}}}}},"/subscriptions/{sub_payme_id}/resume":{"patch":{"security":[{"merchantKey":[]}],"operationId":"patch-subscriptions-sub-payme-id-resume","summary":"Resume","tags":["Subscriptions"],"description":"## Overview\n\n**Relevant only for Direct API Integration**\n\nThis endpoint is used to resume subscriptions is in status \"paused\".\nYou can find more information in our guide - [How to create a subscription\n](/marketplaces-and-platforms/payments/how-to-create-subscription).","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"MPL. Your private key in PayMe system.","schema":{"type":"string"}},{"name":"sub_payme_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success"}}}},"/subscriptions/{sub_id}/set-price":{"patch":{"operationId":"patch-subscriptions-sub-id-set-price","summary":"Update Price","tags":["Subscriptions"],"description":"## Overview\r\n\r\n\r\nThis endpoint is used to update a subscription price.\r\nThis will apply subscriptions in status \"active\" or subscription template in status \"initial\".\r\n\r\nYou can find more information in our guide - [Subscriptions\r\n](/payments/subscriptions/post-generate-subscription).","parameters":[{"name":"sub_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"sub_price":{"type":"string","description":"A single iteration final price.\r\nFor example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075. Note that the minimum value is 500"}},"required":["seller_payme_id","sub_price"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","sub_price":500}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)>\n\nAllowed values `0` `1`"}}}}}},"400":{"description":"","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)>\n\nAllowed values `0` `1`"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}}}}}}}},"/capture-buyer-token":{"post":{"operationId":"post-capture-buyer-token","summary":"Capture Buyer Token","tags":["Tokenization"],"description":"## Overview\n\nThis endpoint can be used only if you are PCI compliant and are able to handle raw credit card infromation. \n\nThis end-point is used to create a new token, by sending a request with the full credit card data and getting a response with the token. This token can be used later on to perform sales and other payment actions.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"buyer_name":{"type":"string","description":"Buyer's full name\r\n"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number"},"buyer_email":{"type":"string","description":"Buyer's email address\r\n"},"buyer_phone":{"type":"string","description":"Buyer's phone number"},"buyer_zip_code":{"type":"string","description":"Buyer's address zip code"},"credit_card_number":{"type":"integer","description":"Card number"},"credit_card_exp":{"type":"string","description":"Buyer's card exp (MMYY)"},"credit_card_cvv":{"type":"integer"},"buyer_perform_validation":{"type":"boolean","description":"Flag for performing an online validation of the card with the Issuer."}},"required":["seller_payme_id","credit_card_number","credit_card_exp","credit_card_cvv"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","buyer_name":"Idan testing","buyer_social_id":"123456789","buyer_email":"TestTest@paymeservice.com","buyer_phone":"05222222","buyer_zip_code":"1q2w3exx","credit_card_number":4111111111111111,"credit_card_exp":"0322","credit_card_cvv":123}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Action status code (0 - Success, 1 - Failure)"},"buyer_key":{"type":"string","description":"Buyer's unique token"},"buyer_name":{"type":"string","description":"Buyer's full name\r\n\r\n"},"buyer_email":{"type":"string","description":"Buyer's email address\r\n\r\n"},"buyer_phone":{"type":"string","description":"Buyer's phone number"},"buyer_card_mask":{"type":"string","description":"Buyer's card mask\r\n"},"buyer_card_exp":{"type":"string","description":"Buyer's card exp (MMYY)"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number"},"buyer_is_permanent":{"type":"boolean","description":"Is the token temporary or permanant"},"buyer_status":{"type":"integer","description":"The status's buyer"}}},"example":{"status_code":0,"buyer_key":"BUYER168-6667348Q-V8Z99RXJ-CQ60HNGY","buyer_name":"Ran Tester","buyer_email":"TestTest@paymeservice.com","buyer_phone":"05222222","buyer_card_mask":"532610******5846","buyer_card_exp":"0426","buyer_social_id":"123456789","buyer_is_permanent":false,"buyer_status":null}}}},"356":{"description":"","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"boolean"},"status_error_code":{"type":"integer"},"session":{"type":"string"}}},"example":{"status_code":1,"status_error_details":"תוקף כרטיס אשראי לא תקין","status_additional_info":false,"status_error_code":356,"session":"khANe7Jl"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"integer"},"session":{"type":"string"}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"credit_card_cvv","status_error_code":1,"session":"0PFThooQ"}}}}}}},"/get-buyer-key":{"post":{"operationId":"post-get-buyer-key","summary":"Get Buyer Key","tags":["Tokenization"],"description":"## Overview\n\nThis API endpoint will allow you to get the buyer-key created and used to pay for a certain payment request in our system. \n\n#### Use Case for Israeli Direct Debit\nOnce a new authorization request is created and the buyer is approved, a new buyer key is generated behind the scenes and can be obtained using this API endpoint.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_sale_id":{"type":"string","description":"Our unique sale ID."},"seller_payme_id":{"type":"string","description":"Our unique seller ID."}},"required":["payme_sale_id","seller_payme_id"]},"example":{"payme_sale_id":"SALE1686-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_payme_id":"MPL16852-XXXXXXXX-XXXXXXXX-XXXXXXXX"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"payme_sale_id":{"type":"string","description":"Our unique sale ID."},"buyer_key":{"type":"string","description":"Buyer's unique token."},"buyer_card_mask":{"type":"string","description":"Buyer's card mask."},"buyer_card_expiry":{"type":"string","description":"Buyer's card exp (MMYY)."},"buyer_card_brand":{"type":"string","description":"Buyer's card brand."},"status_code":{"type":"string"}}},"example":{"payme_sale_id":"MPL90005-90005EXM-EXAMPLE0-EXAMPLE9","buyer_key":"BUYER166-5640185F-UFEKYAYD-WLJSO6QS","buyer_card_mask":"532610******5846","buyer_card_expiry":"0426","buyer_card_brand":"099474924","buyer_is_permanent":null,"status_code":null}}}},"600":{"description":"","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"integer"},"session":{"type":"string"}}},"example":{"status_code":1,"status_error_details":"Buyer not found","status_additional_info":"No Buyer for Sale","status_error_code":600,"session":"St4K2Azk"}}}}}}},"/buyer-token-to-card-number":{"post":{"operationId":"post-buyer-token-to-card-number","summary":"Get card details by token","tags":["Tokenization"],"description":"## Overview\n\nThis endpoint can be used only if you are PCI compliant and allow to handle raw credit card infromation. \n\nThis end-point is used for receiving the full credit card data by sending a request with the buyer token.\n\nPlease note that in the response you won't receive CVV details, as we don't save it due to regulation.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID."},"buyer_uuid2":{"type":"string","description":"Buyer's public key"},"buyer_key":{"type":"string","description":"Buyer's private key"}}},"example":{"seller_payme_id":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","buyer_uuid2":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","buyer_key":"BUYER111-XXXXXXXX-XXXXXXXX-XXXXXXXX"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"buyer_key":{"type":"string","description":"Buyer's unique token."},"buyer_card_number":{"type":"string","description":"Buyer's card mask."},"buyer_card_exp_month":{"type":"string","description":"Buyer's card exp (MMYY)."},"buyer_card_exp_year":{"type":"string","description":"Credit card expiration date"}}},"example":{"buyer_key":"BUYER111-XXXXXXXX-XXXXXXXX-XXXXXXXX","buyer_card_number":"532**********846","buyer_card_exp_month":"04","buyer_card_exp_year":"26","status_code":0}}}}}}},"/create-seller":{"post":{"operationId":"post-create-seller","summary":"Create Seller","tags":["Merchants Management"],"description":"## Overview\n\n**Relevant only to PayMe's partners.**\nThis endpoint allows you to create a seller as one of PayMe's partners.\nYou can find more information in the following guide - [How to Create New Sellers](/marketplaces-and-platforms/sellers/create-seller).\n\n##### Testing\n For testing purposes you can use the following testing values:\nAttributes\t|Value\n---|---\nseller_social_id|\t`9999999999`\nseller_email\t|`random@paymeservice.com` Note that by using this email you will not receive any automatic emails sent from the system\nseller_bank_code|\t`54`\nseller_bank_branch|\t`123` Any 3 digits\nseller_bank_account_number|\t`123456` Any 6 digits\n\n#### Callback upon Seller creation or update\nOnce the Seller is created or updated, we will notify the marketplace with the Seller details with a POST request of type `x-www-form-urlencoded` to the marketplace Default Callback URL.\n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key."},"seller_first_name":{"type":"string","description":"Seller's first name"},"seller_last_name":{"type":"string","description":"Seller's last name"},"seller_social_id":{"type":"string","description":"Seller's social ID"},"seller_birthdate":{"type":"string","description":"Seller's personal birth date. (\ndd/mm/yyyy structured)"},"seller_social_id_issued":{"type":"string","description":"Seller's personal social ID issuing day.(\ndd/mm/yyyy structured)"},"seller_gender":{"type":"number","description":"Seller's gender ( 0- Male, 1- Female)"},"seller_email":{"type":"string","description":"Seller's email address"},"seller_phone":{"type":"string","description":"Seller's phone number"},"seller_contact_email":{"type":"string","description":"Seller's contact email"},"seller_contact_phone":{"type":"string","description":"Seller's contact phone number that will be displayed to the buyers. If not stated, will be copied from seller_phone"},"seller_bank_code":{"type":"number","description":"Seller's bank code (Israeli only)\nPlease see the full list of banks [Banks in Israel](/marketplaces-and-platforms/lists-statuses/banks-in-israel)."},"seller_bank_branch":{"type":"number","description":"Seller's bank branch code"},"seller_bank_account_number":{"type":"string","description":"Seller's bank account number"},"seller_description":{"type":"string","description":"Seller’s description, including offered product line and services. Limited to 255 characters.\n"},"seller_site_url":{"type":"string","description":"Seller’s site URL.\n"},"seller_person_business_type":{"type":"number","description":"Business MCC (Merchant category code). List of codes [MCC List](/marketplaces-and-platforms/lists-statuses/mcc-list)."},"seller_inc":{"type":"number","description":"Seller incorporation type (IL Only)\n\nYou can find all the seller incorporation types [Seller Incorporation Types (IL)](/marketplaces-and-platforms/lists-statuses/seller-incorporation-types-il).\n"},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ), required when seller_inc is not 1."},"seller_retail_type":{"type":"number","description":"Seller's retail type. (1 - Card not present (online) seller, 2 - Card present seller)."},"seller_merchant_name":{"type":"string","description":"Seller's merchant name, required when seller_inc is not 1."},"seller_address_city":{"type":"string","description":"Seller's business address - City."},"seller_address_street":{"type":"string","description":"Seller's business address - Street.\r\n\r\n"},"seller_address_street_number":{"type":"string","description":"Street number"},"seller_address_country":{"type":"string","description":"Seller's business address - Country code according to the ISO 3166. You can fond all the country codes [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)."},"market_fee":{"type":"number","description":"A decimal between 0.00 and 60.00 representing the percent of the sale price that is collected for the marketplace (includes VAT). This fee is added on top of our fees and transferred to the marketplace once a month. Default value is 0"},"language":{"type":"string","description":"Changes the error message language to English. Default value is Hebrew (he)."},"seller_plan":{"type":"string","description":"A predefined set of settings for the seller. If required, this value will be provided by your Account Manager."},"seller_merchant_name_en":{"type":"string","description":"The seller's international name in English"},"seller_additional_details":{"type":"object","properties":{"first_name":{"type":"string","description":"Seller's first name"},"last_name":{"type":"string","description":"Seller's last name"},"social_id":{"type":"string","description":"Seller's social ID"},"social_id_issued":{"type":"string","description":"The social id document issuing date ( dd/mm/yyyy structured)"},"type":{"type":"array","description":"Possible Role. An individual can have multiple roles in a company.\n\nYou can find all the individual seller types [Individual Seller Types](/marketplaces-and-platforms/lists-statuses/individual-seller-types)."},"type_copy":{"type":"array","description":"Possible Role. An individual can have multiple roles in a company.\n\nYou can find all the individual seller types [Individual Seller Types](/marketplaces-and-platforms/lists-statuses/individual-seller-types)."},"email":{"type":"string","description":"Seller's Email"},"files":{"type":"object","description":"Files related to the individual, like id","properties":{"type":{"type":"number","description":"You can find [File Types](/marketplaces-and-platforms/lists-statuses/file-types) the file types you can upload. \n\nOnly individual types are valid: 90-95."},"url":{"type":"string","description":"File URL"},"base64":{"type":"string","description":"The base64 encoded file"},"name":{"type":"string","description":"File name with extension. Allowed file extensions: `pdf`, `jpg`, `jpeg`, `png`, `bmp`, `tiff`, `doc`, `docx`"},"mime_type":{"type":"string","description":"The mime type of the file. Most common mime types are supported, such as `application/pdf`, `application/msword`, `image/png`, `image/jpg`, `image/jpeg`, `image/tiff`, `jfif`."}}}}},"seller_dba":{"type":"string","description":"The seller's legal/registered name in Hebrew."},"seller_dba_en":{"type":"string","description":"The seller's legal/registered international name in English."},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us."}},"required":["payme_client_key","seller_first_name","seller_last_name","seller_social_id","seller_birthdate","seller_social_id_issued","seller_gender","seller_email","seller_phone","seller_bank_code","seller_bank_branch","seller_bank_account_number","seller_description","seller_site_url","seller_person_business_type","seller_inc","seller_merchant_name","seller_address_city","seller_address_street","seller_address_street_number","seller_address_country"]},"example":{"payme_client_key":"string","seller_id":"1234","seller_first_name":"string","seller_last_name":"string","seller_social_id":"string","seller_birthdate":"string","seller_social_id_issued":"string","seller_gender":0,"seller_email":"string","seller_phone":"string","seller_bank_code ":0,"seller_bank_branch":0,"seller_bank_account_number":"string","seller_description":"string","seller_site_url":"string","seller_person_business_type":0,"seller_inc":0,"seller_retail_type":1,"seller_merchant_name":"string","seller_address_city":"string","seller_address_street":"string","seller_address_street_number":"string","seller_address_country":"string","market_fee":0,"seller_registration_date":"string"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"},"seller_payme_id":{"type":"string","description":"The MPL the authorization will be given for"},"seller_payme_secret":{"type":"string","description":"The seller's secret key"},"seller_public_key":{"type":"object","description":"PayMe seller's public key details","properties":{"uuid":{"type":"string","description":"PayMe seller's public key"},"description":{"type":"string","description":"PayMe seller's public key description"},"is_active":{"type":"boolean","description":"Indicates if the public key is active or not (active = true)"}}},"seller_id":{"type":"string","description":"The seller's ID"},"seller_dashboard_signup_link":{"type":"string","description":"Link for the signup process"}}},"example":{"status_code":0,"seller_payme_id":"string","seller_payme_secret":"string","seller_public_key":{"uuid":"string","description":"string","is_active":true},"seller_id":"string","seller_dashboard_signup_link":"string"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":0,"status_error_details":"string","status_additional_info":null,"status_error_code":0}}}}}}},"/update-seller":{"post":{"operationId":"post-update-seller","summary":"Update Seller","tags":["Merchants Management"],"description":"## Overview\n\n**Relevant only to PayMe's partners.**\n\nYou can update your sellers information using the update-seller endpoint easily. \n\n##### Testing\n For testing purposes you can use the following testing values:\nAttributes\t|Value\n---|---\nseller_social_id|\t`9999999999`\nseller_email\t|`random@paymeservice.com` Note that by using this email you will not receive any automatic emails sent from the system\nseller_bank_code|\t`54`\nseller_bank_branch|\t`123` Any 3 digits\nseller_bank_account_number|\t`123456` Any 6 digits\n\n#### Callback upon Seller creation or update\nOnce the Seller is created or updated, we will notify the marketplace with the Seller details with a POST request of type `x-www-form-urlencoded` to the marketplace Default Callback URL.\n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key."},"seller_payme_id":{"type":"string","description":"MPL. Your private key in PayMe system."},"seller_first_name":{"type":"string","description":"Seller's first name"},"seller_last_name":{"type":"string","description":"Seller's last name"},"seller_social_id":{"type":"string","description":"Seller's social ID"},"seller_birthdate":{"type":"string","description":"Seller's personal birth date. (\ndd-mm-yyyy structured)"},"seller_social_id_issued":{"type":"string","description":"Seller's personal social ID issuing day.(\ndd-mm-yyyy structured)"},"seller_gender":{"type":"number","description":"Seller's gender ( 0- Male, 1- Female)"},"seller_email":{"type":"string","description":"Seller's email address"},"seller_phone":{"type":"string","description":"Seller's phone number"},"seller_contact_email":{"type":"string","description":"Seller's contact email"},"seller_contact_phone":{"type":"string","description":"Seller's contact phone number that will be displayed to the buyers. If not stated, will be copied from seller_phone"},"seller_bank_code":{"type":"number","description":"Seller's bank code (Israeli only)\nPlease see the full list of banks [Banks in Israel](/marketplaces-and-platforms/lists-statuses/banks-in-israel)."},"seller_bank_branch":{"type":"number","description":"Seller's bank branch code"},"seller_bank_account_number":{"type":"string","description":"Seller's bank account number"},"seller_description":{"type":"string","description":"Seller’s description, including offered product line and services. Limited to 255 characters.\n"},"seller_site_url":{"type":"string","description":"Seller’s site URL.\n"},"seller_person_business_type":{"type":"number","description":"Business MCC (Merchant category code). List of codes [MCC List](/marketplaces-and-platforms/lists-statuses/mcc-list)."},"seller_inc":{"type":"number","description":"Seller incorporation type (IL Only)\n\nYou can find all the seller incorporation types [Seller Incorporation Types (IL)](/marketplaces-and-platforms/lists-statuses/seller-incorporation-types-il).\n"},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ), required when seller_inc is not 1."},"seller_retail_type":{"type":"number","description":"Seller's retail type. (1 - Card not present (online) seller, 2 - Card present seller)."},"seller_merchant_name":{"type":"string","description":"Seller's merchant name, required when seller_inc is not 1."},"seller_address_city":{"type":"string","description":"Seller's business address - City."},"seller_address_street":{"type":"string","description":"Seller's business address - Street.\r\n\r\n"},"seller_address_street_number":{"type":"string","description":"Street number"},"seller_address_country":{"type":"string","description":"Seller's business address - Country code according to the ISO 3166. You can fond all the country codes [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)."},"market_fee":{"type":"number","description":"A decimal between 0.00 and 60.00 representing the percent of the sale price that is collected for the marketplace (includes VAT). This fee is added on top of our fees and transferred to the marketplace once a month. Default value is 0"},"language":{"type":"string","description":"Changes the error message language to English. Default value is Hebrew (he)."},"seller_plan":{"type":"string","description":"A predefined set of settings for the seller. If required, this value will be provided by your Account Manager."},"seller_merchant_name_en":{"type":"string","description":"The seller's international name in English"},"seller_additional_details":{"type":"object","properties":{"first_name":{"type":"string","description":"Seller's first name"},"last_name":{"type":"string","description":"Seller's last name"},"social_id":{"type":"string","description":"Seller's social ID"},"type":{"type":"array","description":"Possible Role. An individual can have multiple roles in a company.\n\nYou can find all the individual seller types [Individual Seller Types](/marketplaces-and-platforms/lists-statuses/individual-seller-types)."},"email":{"type":"string","description":"Seller's Email"}}},"seller_dba":{"type":"string","description":"The seller's legal/registered name in Hebrew."},"seller_dba_en":{"type":"string","description":"The seller's legal/registered international name in English."}},"required":["payme_client_key","seller_payme_id","seller_first_name","seller_last_name","seller_social_id","seller_birthdate","seller_social_id_issued","seller_gender","seller_email","seller_phone","seller_bank_code","seller_bank_branch","seller_bank_account_number","seller_description","seller_site_url","seller_person_business_type","seller_inc","seller_merchant_name","seller_address_city","seller_address_street","seller_address_street_number","seller_address_country"]},"example":{"payme_client_key":"string","seller_id":"1234","seller_first_name":"string","seller_last_name":"string","seller_social_id":"string","seller_birthdate":"string","seller_social_id_issued":"string","seller_gender":0,"seller_email":"string","seller_phone":"string","seller_bank_code ":0,"seller_bank_branch":0,"seller_bank_account_number":"string","seller_description":"string","seller_site_url":"string","seller_person_business_type":0,"seller_inc":0,"seller_retail_type":1,"seller_merchant_name":"string","seller_address_city":"string","seller_address_street":"string","seller_address_street_number":"string","seller_address_country":"string","market_fee":0,"seller_registration_date":"string"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"},"seller_payme_id":{"type":"string","description":"The MPL the authorization will be given for"},"seller_payme_secret":{"type":"string","description":"The seller's secret key"},"seller_public_key":{"type":"object","description":"PayMe seller's public key details","properties":{"uuid":{"type":"string","description":"PayMe seller's public key"},"description":{"type":"string","description":"PayMe seller's public key description"},"is_active":{"type":"boolean","description":"Indicates if the public key is active or not (active = true)"}}},"seller_id":{"type":"string","description":"The seller's ID"},"seller_dashboard_signup_link":{"type":"string","description":"Link for the signup process"}}},"example":{"status_code":0,"seller_payme_id":"string","seller_payme_secret":"string","seller_public_key":{"uuid":"string","description":"string","is_active":true},"seller_id":"string","seller_dashboard_signup_link":"string"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":0,"status_error_details":"string","status_additional_info":null,"status_error_code":0}}}}}}},"/upload-seller-files":{"post":{"operationId":"post-upload-seller-files","summary":"Upload Seller Files","tags":["Merchants Management"],"description":"## Overview\n\nThis endpoint is used to upload files of a seller.\n\nYou can find [File Types](/marketplaces-and-platforms/lists-statuses/file-types) the file types you can upload.\n\nUploading files can be done using one or both of the following formats:\n\n#### URL of the file\n\nAttribute|Description\n---------|----------\nname|`social_id.pdf` File name with extension\ntype| `1` The document type code\nurl| `https://www.mysite.com/files/social_id.pdf` The URL of the file\nmime_type| `application/pdf` The mime type of the file\n\n#### base64 encoded file\nAttribute|Description\n---------|----------\nname|`social_id.pdf` File name with extension\ntype|`1` The document type code\nbase64|The base64 encoded file\nmime_type|`application/pdf` The mime type of the file\n\n\n\n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your private key provided by us for authentication"},"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"seller_files":{"type":"array","description":"Array of files according to the format described below","items":{"type":"object","properties":{"name":{"type":"string","description":"File name with extension. Allowed file extensions: `pdf`, `jpg`, `jpeg`, `png`, `bmp`, `tiff`, `doc`, `docx`."},"type":{"type":"number","description":"You can find [File Types](/marketplaces-and-platforms/lists-statuses/file-types) the file types you can upload."},"url":{"type":"string","description":"File URL"},"base64":{"type":"string","description":"The base64 encoded file"},"mime_type":{"type":"string","description":"The mime type of the file. Most common mime types are supported, such as `application/pdf`, `application/msword`, `image/png`, `image/jpg`, `image/jpeg`, `image/tiff`, `jfif`."}},"required":["name","type","mime_type"]}}},"required":["payme_client_key","seller_payme_id","seller_files"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_files":[{"name":"dummy.pdf","type":1,"url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf","mime_type":"application/pdf"},{"name":"test.png","type":2,"base64":"iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAklEQVR4AewaftIAAAkOSURBVO3BabDdZWEH4OecXKUUQeAmYRGtW2lLRVBIUkNhJgI6shgWW1nUCJgmpRMoEATNQLmFRtZWIhJEqLLHChkEKYsKKTTQkOgkECgoCtqyhL0hjEswtx/eD3/PnHO3JPeac8/veURERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERLShmvhdt+BgPIhJWpuMxRotwhTD5xHsgutxtNY+g6s0ugLTDZ9f4804G2dq7R9xhkZfwLnaQF0MxbuwWLPb/X7tj6s0u8Pv10ycodnt2kSXGIqTVbbHKpuGkxWv4y02HScrVmB3baguhmKS4hassumYpPiaTUc3/ljxNW2qLoaiW/GMTUcN2yiesenYVuVZbaouflevwek1snr1rabSa2T16ltNpVeb6tLeTsGFKtfi0wZ2Gs5V2RUr8ZqNYz5mqpyFHgO7HNNV/hC/xBobx13YX+VTuM7A7sYUxdPYSbEGmxnFatrTHlimb9/CEZrth+9p7SXciBl4EJNUHsOfaG0hDld8Egv0bS7maDYT87W2BGuwL67H0SpvYIzWzsdpijk4R9+OxTc0uwCztXYd9sI7cTbOVLwLP9O3Gbhcm+jSnu5VvIxulYtwMtZq9mF8T+VsnKlYhj0ww/rbEQsUSzFR5Tv4ONZq9jeYrzINVytexSQbZh+co7gBR6k8gl2wVrPzMVtlL9yPsXgBR+sANe3nMNyk2B6rDM6L6Fa8Fas12gJrFA9ikmY/xbsxH8dr9HmchzXY0uBsjVcUL2C8ZrthueJ6HK1RHb9VnIJ/1uhyTMdyfMDg7ImligcwWbNP4NuKs3GmRjvjccUh+I42VNd+xinWYpXB+Ry6FUdgtWav41brb5ziFwbvdJUDtLYCj1p/4xT/a/BOUzlAazfiN0a5uvazQvEmzDc4hymex7cMjxWKXXCKwTlUsRjLDI8VioMw1eAcprgar+pgde3nv3ClYiZ6cbH+7a5YZPhci0WKC9GLE/RtC+ysuNfwOQtPK25GLw7Qt/ejrvgPHa5Le/ocluMrihNwgmJbvKLRWMWzhtcUfBknKi7GxXgJYzUaq/KM4bUTvosDFbcpluAvNBqn8qwOV9e+LkENu2r0Ms7XaJ1ijOH396jhUJVu9GKGyjqVuuF3EGqYrTIJvdhXZZ3KGB2urv2tRA01PKc4FR9VeVHxNiPnZtTwFpXL8F7Fiyo7GTkXoYbdVb6v8oLKjjpc3eiyA55XHKLy34rJRt7r2EplquKXeEox2chbgQ+qTFU8pjJZh6sbfR5W/IHKnYrtcLi+bWt4vIafKzZXuVOxF3bTt27D42GVzRVv4PuKadhCa1vizUa5uvZzHHq1Ng77KpaqXKxyI7o1ewR7WX9fwhNa+xD+SLFMZZ7KPVr7Nbaz/r6NO7R2pMoylXkq92j2DqzWAbq0l7fjCkWv4jO4BrfiIMUqXKqyFtNwleJFrc3CVwzdFJyu6FVMxgN4FH+mWIw7VB7F2TgD26BXa+fj84ZuOj6h6FVsh+exFl2Kq/GEyq24HkdhAnq1dhsONIqN0V5Wowc7YE/FoTgLOyueww6arcByHKG1HbEN/hpP4wrNTsQ2WIbbVJ5CD/bGuxXH4SyMU/wn9tbsHqzBRzR7HZthD+yHh7FQoxr+QXEXHlD5EXpwDLZWnIqzUFd8E5/VbCG2wwTNHsL2mIIP4l7co1E3ZikW4HEREREREREREREREREREREREaNXTee6DkdhDuYa2OWYrtFtOEj/puJmrV2OGQbveYzDRCw1sCfxTo1OxDz9uwR/p7W/wo06RE1nmYglGs3BXH37EO7Xvz3xQ80exAT9+yH21Lcv4p80moil+nYmevTtZXRr9la8amDn4gs6QJfOcSrONzRH4nrFo/hzld2wXLEEXRq9CRMU++JujS7CydgDx+NSze7C/obmShyrmIcTVWbjAmyL2/ExjfZSrMMYzR7Crjgd38CPjXJjdI770YMe9OCLGIO7cZ/WfoNZmIMjNVqFWzEDdbyGB1TW4SbMws80uwszsCW6cK1m16AHPViEzyq+jme0thMOxERcqdH9+BX2w3uxEM+r/ASr8TGt3YfjFT/HA0a5uujPj1HDXK39CIsV+2i2Euv0bblivI3nUtSwVGuXqOyt2b/o20q8oRivA9TFhvqJYqyhG6tYZeS8jqcV4w3NNuhSrNIB6mJDbaV4zdB8ABMUC42srRSrDc10lYU6QJfYUB9WLDF4h2Kh4t/xdSNnArZULDF4l+JvFSfhKR2gS2yIY7G14ip9ew+e0GwO5hpZJymewGJ9m4n5mk3EUh2iLjbEJYqr8aShe8zI+kscqeixfh7XQbrE+roBmytm6N9PUVN5FtvjJryGrYyMmxX34Vr9uwyXKXbFQ4r/w0IcrgPUxfqYhSMUn8SvDM0OqOG32BJLDL9b0K2YamgeRg37Kg7DOTpAXQzVRzBPMQ//Zv1NVUzEPobPBThYcTBesX7uxsWK2TpAXQzF+3Gn4gc40YZZpLKH4XEKZitOx3dtmEWKzfA+o1xdDNZ7sELxOPaz4cao1G18M3Gh4hKcZ8ONUakb5epiMHbCE4qX8KcG9g7M1r8DVFbauI7BfMUCzDKw47Cb/h2gstIo1yUGsgP+R/EGxhqc+/E27I+PavZ23KD4Be608Xwa/6q4HUca2C64QnEqLtTsGByruBLrjHI1neFoXGtwTsKXFdvhOZUjsEDffoD9FMfjqwZnd6zQ6JuYZnDeh0cUn8I1invxJKbp2+k4T3EzphrYCxivA9RFf76k0QKDdylqWKtvb6CGFTaeuSr7YJrBOwRT9O92jBcRERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERETGa/D8Rm8iOzF+WUQAAAABJRU5ErkJggg==","mime_type":"image/png"}]}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"}}},"example":{"status_code":1}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":0,"status_error_details":"string","status_additional_info":"string","status_error_code":0}}}}}}},"/get-vas-seller":{"post":{"operationId":"post-get-vas-seller","summary":"Retrieve Seller's Additional Services Data","tags":["Merchants Management"],"description":"## Overview\n\nThis endpoint is used to retrieve seller's additional services data.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"The PayMe client key"},"seller_payme_id":{"type":"string","description":"The MPL of the seller"}},"required":["payme_client_key","seller_payme_id"]},"example":{"payme_client_key":"<partner-client-key>","seller_payme_id":"MPL00011-00011EXM-EXAMPLE0-EXAMPLE1"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"0 success\n1 failrue"},"seller_payme_id":{"type":"string","description":"The MPL of the seller"},"vas_payme_id":{"type":"string","description":"The VAS guid"},"items_count":{"type":"integer","description":"VASes count"},"items":{"type":"array","items":{"type":"object","properties":{"vas_description":{"type":"string","description":"The VAS description"},"vas_type":{"type":"string","description":"The VAS type"},"vas_api_key":{"type":"string","description":"The VAS Guid"},"vas_is_active":{"type":"boolean","description":"Is the VAS active or not"},"vas_payer_type":{"type":"integer","description":"The payer type"},"vas_price_currency":{"type":"string","description":"VAS fee currency"},"vas_price_setup_fixed":{"type":"integer","description":"VAS setup price (fixed)"},"vas_price_periodic_fixed":{"type":"integer","description":"VAS periodic price (fixed)"},"vas_price_periodic_variable":{"type":"string","description":"VAS periodic price (fixed)"},"vas_price_usage_fixed":{"type":"integer","description":"VAS usage price (fixed)"},"vas_price_usage_variable":{"type":"string","description":"VAS usage price (fixed)"},"vas_market_fee":{"type":"string","description":"VAS market fee"},"vas_period":{"type":"integer","description":"VAS period | Code\r\n----|----\r\nInstant | 1\r\nDaily | 2\r\nMonthly | 3\r\nYearly | 4"},"vas_data":{"type":"array","description":"Data that saved under the VAS"}}}}}},"example":{"status_code":0,"seller_payme_id":"MPL16581-DEMO-DEMO-DEMO","vas_payme_id":null,"items_count":15,"items":[{"vas_description":"עמלת סליקה","vas_type":"Settlements","vas_api_key":null,"vas_is_active":true,"vas_payer_type":2,"vas_price_currency":"ILS","vas_price_setup_fixed":0,"vas_price_periodic_fixed":0,"vas_price_periodic_variable":"0.00","vas_price_usage_fixed":0,"vas_price_usage_variable":"0.00","vas_market_fee":null,"vas_period":1,"vas_data":[]}]}}}}}}},"/withdraw-balance":{"post":{"operationId":"post-withdraw-balance","summary":"Withdraw Balance","tags":["Merchants Management"],"description":"## Overview\n\nThis endpoint is used to generate a new request to withdraw balance.\n\n#### Notes\n*  Until we obtain and verify the 3 mandatory documents (`Social Id, Bank, Corporate Certificate`), funds will not be available for withdrawal to the Seller's bank account.\n* **Partial-withdrawal** - In order to create a partial-withdrawal, you will need to add another parameter to your request which states which transactions you are willing to get the balance for to your bank account.\n\nParameter|Description\n---|---\n`transaction_ids`| The transaction GUIDs that will be included as a part of your withdrawal request. \n\n### Withdrawal Callback Notification Types\nNotification\t|Description\n--|--\nwithdrawal-complete\t|A withdrawal was completed successfully\n\nAttribute|\tDescription\n--|--\nstatus_code\t|`0` Status of the request (0 - success, 1 - error)\nnotify_type\t|`withdrawal-complete`\nseller_payme_id|\t`XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX`\ntran_payme_code|\t`123456` Our unique Withdrawal code\ntran_created\t|`2016-01-01 15:15:15`\ntran_type\t|`40` Financial Transaction type Bank Withdrawal\ntran_currency\t|`USD`\ntran_total\t|`10000`\ntran_description|\t`משיכה לבנק\n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your private key provided by us for authentication"},"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"withdrawal_currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"language":{"type":"string","description":"Changes the error message language to English. Default value is Hebrew (he)"},"transaction_ids":{"type":"array","description":"The transaction IDs that will be used for the partial withdrawal request. Transaction guids can be fetched using our `get-transcations` API endpoint.\r\n\n\n Example: TRANDEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX"}},"required":["payme_client_key","seller_payme_id","withdrawal_currency"]},"example":{"payme_client_key":"string","seller_payme_id":"string","withdrawal_currency":"string"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"}}},"example":{"status_code":0}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":0,"status_error_details":"string","status_additional_info":null,"status_error_code":0}}}}}}},"/sellers/{seller_payme_id}/public-keys":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-sellers-mpl-public-keys","summary":"Get Seller Public Key","tags":["Merchants Management"],"description":"## Overview\n\nThis API endpoint will allow you as a partner to get the unique public keys used for various services in our system. \n\n","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":true,"description":"The PayMe unique partner key.","schema":{"type":"string"}},{"name":"seller_payme_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status code 0 - Success\nStatus code 1 - Failure"},"page":{"type":"integer","description":"Page presented"},"items_total":{"type":"integer","description":"Total count of items"},"items_per_page":{"type":"integer","description":"Items per page count"},"seller_payme_id":{"type":"string","description":"The unique seller ID"},"items":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The unique public key"},"description":{"type":"string","description":"The public key title"}}}}}},"example":{"status_code":0,"page":1,"items_total":1,"items_per_page":1,"seller_payme_id":"MPL151111-1111111-SAUCJ4KX-TVEDZCIN","items":[{"uuid":"12345678-7c83-46fc-ac97-12345678","description":"PayMe-Public-Key"}]}}}}}}},"/sales/{guid}/external-market-fee":{"patch":{"security":[{"partnerKey":[],"merchantKey":[]}],"operationId":"patch-sales-guid-external-market-fee","summary":"Delayed Market Fee","tags":["Merchants Management"],"description":"## Overview\n\nThis endpoint allows you to create a new charge (fee) that is connected to a sale and is limited by the transaction amount. \n\n### Limitations\n\n1. You must include at least one of the following - `market_fee_percentage` or `market_fee_fixed`\n2. The sale must be generated by the MPL\n3. `market_fee_percentage` - can be from 0.0 to 60.0\n4. `market_fee_fixed` - limited to the amount settled to the wallet and cannot be higher than that. ","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"The partner secret key.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"The MPL of the seller.","schema":{"type":"string"}},{"name":"guid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"market_fee_percentage":{"type":"number","description":"The percentage that will be charged. \nLimited to be between 0 to 60.\n"},"market_fee_fixed":{"type":"integer","description":"The fixed market fee - limited to the amount settled to the wallet."}}},"example":{"market_fee_percentage":10.2,"market_fee_fixed":15000}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"0 - Sucess\n1 - Failure"},"payme_status":{"type":"string","description":"The status of the action."},"payme_sale_id":{"type":"string","description":"The sale the fee was associated with. "}}},"example":{"status_code":0,"payme_status":"success","payme_sale_id":"SALEGUID-SALEGUID-SALEGUID-SALEGUID"}}}}}}},"/sellers/{mpl_key}/individuals":{"post":{"security":[{"merchantKey":[]}],"operationId":"post-sellers-mpl-key-individuals","summary":"Create Individual","tags":["Merchants Management"],"description":"## Overview\n\nUsing this method, you will be able to create a new individual under your company.\n\nWhen creating an individual, you will need to set it's roles based on the following list:\n\nRole | Enum \n-- | --\nOwner | 1 \nSignatory | 2\nDirector | 4 \nExecutive | 8\nBack Office | 16\n","parameters":[{"name":"PayMe-Signature","in":"header","required":false,"description":"Example: sk_test_<your-key>_123123213123","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"Example: MPL123-123-123","schema":{"type":"string"}},{"name":"mpl_key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"Individual's first name in the company's local language."},"first_name_en":{"type":"string","description":"Individual's first name in English."},"last_name":{"type":"string","description":"Individual's last name in the company's local language."},"last_name_en":{"type":"string","description":"Individual's last name in english."},"national_id":{"type":"string","description":"Individual's national ID."},"social_id":{"type":"string","description":"Individual's national ID (Will be deprecated)."},"social_id_issued":{"type":"string","description":"Individual's Social ID issuing date."},"social_id_country":{"type":"string","description":"Individual's Social ID issuing country."},"birthdate":{"type":"string","description":"The birthdate of the individual."},"gender":{"type":"string","description":"The gender of the individual."},"email":{"type":"string","description":"The email address of the individual.\nMust be in an email address format.\n"},"phone":{"type":"string","description":"The phone number of the individual."},"bank":{"type":"string","description":"The bank code of the invdividual."},"bank_account":{"type":"string","description":"The bank account number of the invdividual."},"bank_account_branch":{"type":"string","description":"The bank account branch of the invdividual."},"bank_account_number_foreign":{"type":"string","description":"The foreign bank account number of the individual."},"bank_routing_number_foreign":{"type":"string","description":"The foreign bank account routing number of the individual."},"iban":{"type":"string","description":"The individual's bank account IBAN."},"is_active":{"type":"boolean","description":"The indicator whether the individual is a part of the company or not."},"block_reason":{"type":"string","description":"The block reason of the individual from accessing PayMe's platform and data."},"account_status":{"type":"string","description":"The individual's account status."},"address_street":{"type":"string","description":"The street address of the individual."},"address_street_intl":{"type":"string","description":"The international street address of the individual."},"address_street_number":{"type":"string","description":"The street address number of the individual."},"address_zip":{"type":"string","description":"The street address ZIP code of the individual."},"address_city":{"type":"string","description":"The street address city of the individual."},"address_city_intl":{"type":"string","description":"The international street address city of the individual."},"address_country":{"type":"string","description":"The street address country of the individual."},"address_state":{"type":"string","description":"The street address state of the individual."},"additional_data":{"type":"string","description":"Any additional data that needs to be stored under the individual in a JSON format."},"role":{"type":"array","description":"     1 => \"Owner\",\n     2 => \"Signatory\",\n     4 => \"Director\",\n     8 => \"Executive\",\n     16 => \"Back Office\","},"is_primary":{"type":"boolean","description":"Setting the primary flag under the company whether the individual is the primary of the company."},"ownership_percentage":{"type":"string","description":"Example: \n\"20.5\""},"business_title":{"type":"string","description":"The business title of the individual."}}},"example":{"individual_first_name":"John","individual_first_name_en":"John","individual_last_name":"Doe","individual_last_name_en":"Doe","individual_national_id":"1234567890","individual_social_id":"987654321","individual_social_id_issued":"2022-01-01","individual_social_id_country":"US","individual_birthdate":"1990-01-01","individual_gender":"Male","individual_email":"johndoe@example.com","individual_phone":"1234567890","individual_bank":"PayMe Bank","individual_bank_account":"9876543210","individual_bank_account_branch":"Main Branch","individual_bank_account_number_foreign":"1234567890","individual_bank_routing_number_foreign":"ABCDEFG12345","individual_iban":"US00 ABCD 1234 5678 90","individual_is_active":true,"individual_block_reason":"No reason","individual_account_status":"Active","individual_address_street":"123 PayMe St.","individual_address_street_intl":"123 PayMe St.","individual_address_street_number":"123","individual_address_zip":"12345","individual_address_city":"PayMe City","individual_address_city_intl":"PayMe City","individual_address_country":"US","individual_address_state":"PayMe State","individual_additional_data":"Additional data here"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success"}}},"get":{"security":[{"signature":[]}],"operationId":"get-sellers-mpl-key-individuals","summary":"Get-Individuals by Company ID","tags":["Merchants Management"],"description":"This route will help you receive all of the data regarding the individuals ","parameters":[{"name":"PayMe-Signature","in":"header","required":false,"description":"Example: sk_test_<your-key>_123ASD","schema":{"type":"string"}},{"name":"mpl_key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"page":{"type":"integer"},"items_per_page":{"type":"integer"},"items_total":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"social_id":{"type":"string"},"email":{"type":"string"},"national_id":{"type":"string"},"role":{"type":"array"},"is_primary":{"type":"boolean"},"ownership_percentage":{"type":"string"},"business_title":{"type":"string"},"first_name_international":{"type":"string"},"last_name_international":{"type":"string"},"social_id_issued":{"type":"integer"},"national_id_country":{"type":"string"},"birthdate":{"type":"integer"},"gender":{"type":"integer"},"phone_number":{"type":"string"},"email_address":{"type":"string"},"bank":{"type":"string"},"bank_account_branch":{"type":"string"},"bank_account_number":{"type":"string"},"bank_routing_number_foreign":{"type":"string"},"bank_iban":{"type":"string"},"address_street_name":{"type":"string"},"address_street_international":{"type":"string"},"address_street_number":{"type":"string"},"address_zip_code":{"type":"string"},"address_city_name":{"type":"string"},"address_city_international":{"type":"string"},"address_state_name":{"type":"string"},"address_country_name":{"type":"string"}}}}}},"example":{"status_code":0,"page":1,"items_per_page":500,"items_total":1,"items":[{"guid":"INDV1693-14592531-QZKL0HO9-PO6QZBDN","first_name":"Ohad","last_name":"Dabush","social_id":"301105052","email":null,"national_id":null,"role":["Owner","Signatory","Director","Executive","Back Office"],"is_primary":true,"ownership_percentage":null,"business_title":null,"first_name_international":"","last_name_international":"","social_id_issued":1508907600,"national_id_country":null,"birthdate":562140000,"gender":0,"phone_number":null,"email_address":null,"bank":null,"bank_account_branch":null,"bank_account_number":null,"bank_routing_number_foreign":null,"bank_iban":null,"address_street_name":null,"address_street_international":null,"address_street_number":null,"address_zip_code":null,"address_city_name":null,"address_city_international":null,"address_state_name":null,"address_country_name":null}]}}}}}}},"/sellers/{mpl_key}/individuals/{individual_key}":{"post":{"operationId":"post-sellers-mpl-key-individuals-2","summary":"Update Individual","tags":["Merchants Management"],"description":"## Overview\n\nUsing this method, you will be able to update an existing individual under your company.\n\nWhen creating an individual, you will need to set it's roles based on the following list:\n\nRole | Enum \n-- | --\nOwner | 1 \nSignatory | 2\nDirector | 4 \nExecutive | 8\nBack Office | 16\n\n","parameters":[{"name":"mpl_key","in":"path","required":true,"schema":{"type":"string"}},{"name":"individual_key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"Individual's first name in the company's local language."},"first_name_en":{"type":"string","description":"Individual's first name in English."},"last_name":{"type":"string","description":"Individual's last name in the company's local language."},"last_name_en":{"type":"string","description":"Individual's last name in english."},"national_id":{"type":"string","description":"Individual's national ID."},"social_id":{"type":"string","description":"Individual's national ID (Will be deprecated)."},"social_id_issued":{"type":"string","description":"Individual's Social ID issuing date."},"social_id_country":{"type":"string","description":"Individual's Social ID issuing country."},"birthdate":{"type":"string","description":"The birthdate of the individual."},"gender":{"type":"string","description":"The gender of the individual."},"email":{"type":"string","description":"The email address of the individual.\nMust be in an email address format.\n"},"phone":{"type":"string","description":"The phone number of the individual."},"bank":{"type":"string","description":"The bank code of the invdividual."},"bank_account":{"type":"string","description":"The bank account number of the invdividual."},"bank_account_branch":{"type":"string","description":"The bank account branch of the invdividual."},"bank_account_number_foreign":{"type":"string","description":"The foreign bank account number of the individual."},"bank_routing_number_foreign":{"type":"string","description":"The foreign bank account routing number of the individual."},"iban":{"type":"string","description":"The individual's bank account IBAN."},"is_active":{"type":"boolean","description":"The indicator whether the individual is a part of the company or not."},"block_reason":{"type":"string","description":"The block reason of the individual from accessing PayMe's platform and data."},"account_status":{"type":"string","description":"The individual's account status."},"address_street":{"type":"string","description":"The street address of the individual."},"address_street_intl":{"type":"string","description":"The international street address of the individual."},"address_street_number":{"type":"string","description":"The street address number of the individual."},"address_zip":{"type":"string","description":"The street address ZIP code of the individual."},"address_city":{"type":"string","description":"The street address city of the individual."},"address_city_intl":{"type":"string","description":"The international street address city of the individual."},"address_country":{"type":"string","description":"The street address country of the individual."},"address_state":{"type":"string","description":"The street address state of the individual."},"additional_data":{"type":"string","description":"Any additional data that needs to be stored under the individual in a JSON format."},"role":{"type":"array","description":"     1 => \"Owner\",\n     2 => \"Signatory\",\n     4 => \"Director\",\n     8 => \"Executive\",\n     16 => \"Back Office\","},"is_primary":{"type":"boolean","description":"Setting the primary flag under the company whether the individual is the primary of the company."},"ownership_percentage":{"type":"string","description":"Example: \n\"20.5\""},"individual_business_title":{"type":"string","description":"The business title of the individual."}}},"example":{"individual_first_name":"John","individual_first_name_en":"John","individual_last_name":"Doe","individual_last_name_en":"Doe","individual_national_id":"1234567890","individual_social_id":"987654321","individual_social_id_issued":"2022-01-01","individual_social_id_country":"US","individual_birthdate":"1990-01-01","individual_gender":"Male","individual_email":"johndoe@example.com","individual_phone":"1234567890","individual_bank":"PayMe Bank","individual_bank_account":"9876543210","individual_bank_account_branch":"Main Branch","individual_bank_account_number_foreign":"1234567890","individual_bank_routing_number_foreign":"ABCDEFG12345","individual_iban":"US00 ABCD 1234 5678 90","individual_is_active":true,"individual_block_reason":"No reason","individual_account_status":"Active","individual_address_street":"123 PayMe St.","individual_address_street_intl":"123 PayMe St.","individual_address_street_number":"123","individual_address_zip":"12345","individual_address_city":"PayMe City","individual_address_city_intl":"PayMe City","individual_address_country":"US","individual_address_state":"PayMe State","individual_additional_data":"Additional data here"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success"}}}},"/partners":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-partners","summary":"Get Partner Data","tags":["Merchants Management"],"description":"This API endpoint is dedicated to providing the information regarding the Partner entity.\n\ncUrl command (Paste to Postman Command line / import):\n```\ncurl --location 'https://sandbox.payme.io/api/partners' \\\n--header 'Content-Type: application/json' \\\n--header 'PayMe-Partner-Key: <partner-client-key>' \\\n--data ''\n```","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":true,"description":"Your partner client key","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"page":{"type":"integer"},"items_per_page":{"type":"integer"},"items_total":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"description":{"type":"string"},"created_at":{"type":"string"},"activity_type":{"type":"string"},"main_seller_payme_id":{"type":"string"},"defaults":{"type":"object","properties":{"timezone":{"type":"string"},"default_creation_plan":{"type":"string"},"allow_foreign_cards":{"type":"boolean"},"currencies":{"type":"array"},"processing_limit":{"type":"integer"},"market_fee_display_on_top":{"type":"boolean"},"withdrawal_plan":{"type":"integer"},"withdrawal_date":{"type":"integer"}}},"technical":{"type":"object","properties":{"callback_url":{"type":"string"},"return_url":{"type":"string"},"dashboard_url":{"type":"string"}}}}}}}},"example":{"status_code":0,"page":1,"items_per_page":1,"items_total":1,"items":[{"display_name":"YYY","description":null,"created_at":"2023-08-28 12:02:31","activity_type":"One Off","main_seller_payme_id":"MPL00012-00012EXM-EXAMPLE0-EXAMPLE2","defaults":{"timezone":null,"default_creation_plan":"VPLN1580-718683JV-G2PZHZQW-END7P7WI","allow_foreign_cards":true,"currencies":["ILS"],"processing_limit":5000000,"market_fee_display_on_top":false,"withdrawal_plan":3,"withdrawal_date":1},"technical":{"callback_url":"","return_url":"","dashboard_url":"https://yyy.payme.io"}}]}}}}}}},"/sellers/{mpl_key}/mids":{"get":{"security":[{"partnerKey":[],"merchantKey":[],"signature":[]}],"operationId":"get-sellers-mpl-key-mids","summary":"GET Mids","tags":["Merchants Management"],"description":"Curl Command (Copy to postman command line):\n\n```\ncurl --location 'https://env.payme.io/api/sellers/MPL90010-90010EXM-EXAMPLE0-EXAMPLE9/mids' \\\n--header 'PayMe-Partner-Key: isracard-***********' \\\n--header 'PayMe-Merchant-Key: MPL90099-90099EXM-********-********' \\\n--header 'PayMe-Signature: sk_test_<your-key>'\n```\n\n","parameters":[{"name":"mpl_key","in":"path","required":true,"schema":{"type":"string"}},{"name":"PayMe-Partner-Key","in":"header","required":true,"description":"Your partner client key","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":true,"description":"Your merchant key (MPL)","schema":{"type":"string"}},{"name":"PayMe-Signature","in":"header","required":true,"description":"The signature value PayMe gives you for this endpoint","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"page":{"type":"integer"},"items_total":{"type":"integer"},"items_per_page":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"guid":{"type":"string"},"classification":{"type":"string"},"type":{"type":"string"},"is_paid_directly":{"type":"boolean"},"acquirer":{"type":"string"},"discounter":{"type":"string"},"allowed_payment_methods":{"type":"array"},"max_installments":{"type":"integer"},"allowed_brands":{"type":"array"},"min_processing":{"type":"integer"},"max_processing":{"type":"integer"},"is_active":{"type":"boolean"},"is_relation_active":{"type":"boolean"}}}}}},"example":{"status_code":0,"page":1,"items_total":16,"items_per_page":16,"items":[{"guid":"MID16925-12688EFB-LYQNLFYC-EPL65KAW","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"Isracard","allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":50000,"is_active":false,"is_relation_active":false},{"guid":"MID16925-12737PDV-GUCYB07Z-8ATPZRLN","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"PayMe","allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":5,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12671ODU-Q5XPUVIU-GFCBIEXG","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"PayMe","allowed_payment_methods":["credit-card","bit","pos","il-direct-debit"],"max_installments":36,"allowed_brands":["PrivateLabel","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":0.1,"max_processing":300000,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12766V5P-JRK34MPH-HTV3OIKJ","classification":"Original","type":"None","is_paid_directly":true,"acquirer":"Isracard","discounter":null,"allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":0,"max_processing":0,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12771UVB-WY2LD0TL-UIN5KKWZ","classification":"Shadow","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"Tzameret","allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":5,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12790Q47-VJRQBUI8-9YDY2TXM","classification":"Original","type":"None","is_paid_directly":true,"acquirer":"Isracard","discounter":null,"allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":[],"min_processing":0,"max_processing":0,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12693JTW-LJIU7PA0-JBPI9BLW","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"PayMe","allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":50000,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12954TZC-FC8KXQC7-YWJHSUKM","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"PayMe","allowed_payment_methods":["credit-card","bit","apple-pay","pos"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":50000,"is_active":true,"is_relation_active":true},{"guid":"MID16925-1268967W-XGOTTDQ0-PENRUMM1","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Cal","discounter":"PayMe","allowed_payment_methods":["credit-card","bit","pos"],"max_installments":36,"allowed_brands":["PrivateLabel","Diners","Visa","Mastercard","Discover","Isracard"],"min_processing":1,"max_processing":50000,"is_active":true,"is_relation_active":true},{"guid":"MID16925-12807BVI-JFKNE4H1-EKSZTLV7","classification":"Original","type":"None","is_paid_directly":true,"acquirer":"PayPal","discounter":null,"allowed_payment_methods":["paypal"],"max_installments":12,"allowed_brands":[],"min_processing":0,"max_processing":0,"is_active":true,"is_relation_active":true},{"guid":"MID16925-12862HFU-LGWZBGBC-LDL9VGYC","classification":"Original","type":"None","is_paid_directly":true,"acquirer":"PayPal","discounter":null,"allowed_payment_methods":["paypal"],"max_installments":12,"allowed_brands":["PrivateLabel","Diners","JCB","AmericanExpress","Visa","Mastercard","Discover","UnionPay","Isracard"],"min_processing":0,"max_processing":0,"is_active":true,"is_relation_active":false},{"guid":"MID16925-13002M1Z-FH67BK2Q-HHPKCXAL","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Cal","discounter":"PayMe","allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["PrivateLabel","Diners","Visa","Mastercard","Discover","Isracard"],"min_processing":5,"max_processing":50000,"is_active":false,"is_relation_active":false},{"guid":"MID16925-13017KT2-TMCZZ1DB-D05SI93Y","classification":"Original","type":"None","is_paid_directly":true,"acquirer":"Max","discounter":null,"allowed_payment_methods":["credit-card","bit"],"max_installments":12,"allowed_brands":["Visa"],"min_processing":0,"max_processing":0,"is_active":true,"is_relation_active":false},{"guid":"MID16925-12674IGG-CMNOTGUP-E1XQQ8H8","classification":"Original","type":"Processing","is_paid_directly":false,"acquirer":"Isracard","discounter":"PayMe","allowed_payment_methods":["credit-card","bit","apple-pay"],"max_installments":12,"allowed_brands":["PrivateLabel","JCB","AmericanExpress","Visa","Mastercard","Isracard"],"min_processing":1,"max_processing":50000,"is_active":true,"is_relation_active":false},{"guid":"MID16925-13050DDN-0NIDIVSH-MBBYBTGV","classification":"Original","type":"Processing","is_paid_directly":true,"acquirer":"Payrix","discounter":null,"allowed_payment_methods":["credit-card","echeck","apple-pay"],"max_installments":0,"allowed_brands":["PrivateLabel","Diners","JCB","AmericanExpress","Visa","Mastercard","Discover","UnionPay","Isracard"],"min_processing":1,"max_processing":21474836.47,"is_active":true,"is_relation_active":false},{"guid":"MID16925-13053CLI-ZG3TBVJC-56WVDNPS","classification":"Original","type":"Processing","is_paid_directly":true,"acquirer":"Stripe","discounter":null,"allowed_payment_methods":["credit-card"],"max_installments":0,"allowed_brands":["PrivateLabel","Diners","JCB","AmericanExpress","Visa","Mastercard","Discover","UnionPay","Isracard"],"min_processing":1,"max_processing":200000,"is_active":true,"is_relation_active":false}]}}}},"responses":{"200":{"description":"OK","x-response-kind":"success"}}}},"/business-fields":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-business-fields","summary":"Business Fields","tags":["Merchants Management"],"description":"## Overview\nReturns the list of business fields (the seller's line of business), for example when creating a seller. Each field has a numeric `code`, an international (English) name and a local name.\n\nTo get a single field, add its code to the path: `GET /business-fields/{code}`.\n\n## Authentication\nSend your own partner key (`payme_client_key`) in the `PayMe-Partner-Key` header. A seller can send its `seller_payme_id` instead. Without either, the call fails with error `1` (`status_additional_info`: `payme_client_key`).\n\n## Response structure\n- `status_code`: `0` on success.\n- `page`, `items_per_page`, `items_total`: paging information.\n- `language`: the language of `name_local`.\n- `items`: the business fields, keyed by position; each has `code`, `name_intl` and `name_local`.","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Your partner key (payme_client_key). Required unless you send seller_payme_id.","schema":{"type":"string"}},{"name":"seller_payme_id","in":"query","required":false,"description":"Your seller ID (MPL), as an alternative to PayMe-Partner-Key.","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Field to sort by, for example name_local. Default code.","schema":{"type":"string"}},{"name":"sort_direction","in":"query","required":false,"description":"desc for descending; any other value sorts ascending.","schema":{"type":"string"}},{"name":"language","in":"query","required":false,"description":"Language of name_local (he, en, es, ru or ar). Default Hebrew.","schema":{"type":"string"}},{"name":"allow_children","in":"query","required":false,"description":"Also return child business fields.","schema":{"type":"boolean"}}],"responses":{"default":{"description":"Default","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"page":{"type":"integer"},"items_per_page":{"type":"integer"},"items_total":{"type":"integer"},"language":{"type":"string"},"items":{"type":"object","properties":{"244":{"type":"object","properties":{"code":{"type":"integer"},"name_intl":{"type":"string"},"name_local":{"type":"string"}}}}}}},"example":{"status_code":0,"page":1,"items_per_page":245,"items_total":245,"language":"he","items":{"244":{"code":10565,"name_intl":"Shutters","name_local":"תריסים"}}}}}}}}},"/buyers/{buyer_guid}":{"get":{"security":[{"merchantKey":[]}],"operationId":"get-buyers-guid","summary":"Get Customer Details","tags":["Buyers Management"],"description":"## Overview\n\nYou can access and fetch your buyer's details using this API endpoint. \n\nYour API request structure should look as follows:\n```\nhttps://<env>.payme.io/api/buyers/{buyer_guid}\n```\n\nThe buyer guid is the unique ID fetched from either:\n1. Capture Buyer Token API endpoint.\n2. Tokens API endpoint.\n\n### Authentication\nYou'll need to authenticate your request using the unique seller ID.\n\n### Data\nYou'll be able to get the following data:\n1. Card mask\n2. Card brand\n3. Card expiry date\n4. Customer details\n\n### Limitations\n1. If you are sending a token (uuid) and not a buyer key you won't get the parameter `buyer_key` in your response.","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":true,"description":"Your unique seller UUID.","schema":{"type":"string"}},{"name":"buyer_guid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"Buyer uuid"},"customer":{"type":"object","description":"Customer's details","properties":{"name":{"type":"string","description":"Customer's name"},"email":{"type":"string","description":"Customer's email"},"phone":{"type":"string","description":"Customer's phone"},"social_id":{"type":"string","description":"Customer's ID"}}},"payment":{"type":"object","properties":{"display":{"type":"string","description":"The payment method number"},"expiry":{"type":"string","description":"Buyer's card exp (MMYY)."},"brand":{"type":"string","description":"Buyer's card brand."},"club":{"type":"string","description":"The credit card club"},"type":{"type":"string","description":"Type of credit card"},"organization":{"type":"string","description":"The credit card organization"},"origin_country":{"type":"string","description":"The credit card country"}}},"buyer_key":{"type":"string","description":"Buyer key"}}},"example":{"uuid":"6ac45306-1755-45e4-8b74-f6de3ea2239b","customer":{"name":"Ran Tester","email":"TestTest@paymeservice.com","phone":"05222222","social_id":"123456789"},"payment":{"display":"411111******1111","expiry":"0322","brand":"Visa","club":"","type":"Credit","organization":"","origin_country":"US"},"buyer_key":"BUYER162-6264904Y-TIHEKYED-4QMCI837"}}}}}}},"/sales/payme_sale_id/3ds":{"post":{"security":[{"publicKey":[]}],"operationId":"post-initialize-3dsecure-request","summary":"Initialize 3DSecure Request","tags":["Standalone 3D Secure service"],"description":"This end-point is used for our MPI / 3D secure as-a-service funtionality. \n\nIf you wish to process transactions with a different gateway but wish to use PayMe's MPI capability - this end-point can be used to get 3DS values required for processing a 3DS sale.\n\nPlease follow the instructions that can be found [Hosted Fields JSAPI Guide](/marketplaces-and-platforms/integrations/hosted-fields-jsapi-guide#3ds-integration-using-js-api).\n\nIn order to the 3DS service, you'll need to implement our library in your checkout page and collect the user data, then send it to us as a part of the `sales/{payme_sale_id}/3ds` request.\n\nThe parameter that needs to be sent is the string you receive from the library after initiating the data collection action:\nParamter|Example|Comments\n---|---|---\n`meta_data_jwt` | `eyJ0eXAiOiJKV1QiLCJh.......dyfwpbA` | The JWT string received from the library.\n\n\n","parameters":[{"name":"PayMe-Public-Key","in":"header","required":false,"description":"Merchant's public key.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method for 3DSecure. 3DSecure is a Credit Card module, thus is the only available method"},"card_number":{"type":"string","description":"The card number to make authenticated payment uppon."},"card_expiry":{"type":"string","description":"Card Expiry date. Format: mmyy"}},"required":["method","card_number","card_expiry"]},"customer":{"type":"object","properties":{"name":{"type":"string","description":"Card holder name."},"email":{"type":"string","description":"Card holder email."},"phone":{"type":"string","description":"Card holder mobile phone number."},"zip_code":{"type":"string","description":"Card holder address zip code."},"social_id":{"type":"string","description":"Card holder social id / national id."}},"required":["name","email","phone","zip_code","social_id"]},"meta_data_jwt":{"type":"string","description":"The user data collected from the browser. Must be encrypted by PayMe's service."}},"required":["customer","meta_data_jwt"]},"example":{"payment":{"method":"credit-card","card_number":"4111111111111111","card_expiry":"1221"},"customer":{"name":"developer test","email":"test@paymeservice.com","phone":"0500000006","zip_code":"857393485","social_id":"123456782"}}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success-redirect, 1 - error)"},"status_message":{"type":"string","description":"A message you may show to the buyer"},"redirect_url":{"type":"string","description":"The URL we should redirect (GET method) to the user."}}},"example":{"status_code":5,"status_message":"Generating validation page, please wait","redirect_url":"https://preprod.paymeservice.com/3ds/redirect/SALE1587-486438YT-JLHBOZLR-AJJTULHT?pa=eJxdU9tu4jAQfUfqP1h5T%252Bw4V5BxRZeulpWC2C5V1b55nVmIlAt1kgL79WuTBpL6yXPmjOfMxez%252BVOToA1SdVeXcch1iIShllWblbm49b7%252FbsXXP7yZsu1cAy98gWwV8ghBLoK7FDlCWzi047Lw0FmEsXZumgW%252F7f1PPFj5MbRrQOAyI60EElgnUoZvFE7x3d219Juc6t0MZ7s3enYCSe1E2PaAhId8fVmvuB0Hkewx%252Fmjd%252FAWq15EEU0CgMwsilrn63A68kxEpRAF%252BgBuoG9UkYvqADlqzaslFn7kUhw70x8Lcq5%252FumOdQzjI%252FHo5PVSkihUnuXV39E7siqYNiQ%252Bnrw14LYpjVAPUp7ylKe%252FHvI19uf%252BVuR%252BG8vr%252Bf1cuUn9PGYbH%252FNGTaMQUAqGuCUUEIC4iE3mnnTGdVlX%252FABTxSmBv74%252FIRcQhxCdP86aEA6GEWLDtYsQxpCw%252Fa0Sul9OfNpFOv%252B9NaAAadDVYKO0mKu96FwqCVfwgfaqCptZYPWegJat4FvtGv3vjaLffsxKk%252FKRo%252FZd8fHLMnFMRaW6VlS1%252B2UZbfBMty%252FqhP2y2omd1l5PmF49B3uJv8Blq7hOg%253D%253D&url=https%253A%252F%252Fwww.3dsecurempi.com%252FTDS%252FAUT%253FAction%253DAuthenticate&track=BUYER158-7473169I-GRHJVHIH-VBT25PLM%7CTRAN1588-5275735M-BYGTDXRQ-ZPZT4XRE&pay=0"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string","description":"Error message to the client"},"status_additional_info":{"type":"string","description":"Additional error information\n\n`"},"status_error_code":{"type":"number","description":"Our unique error code\n\n"}}},"example":{"status_code":1,"status_error_details":"Invalid credit card expiry","status_additional_info":"1221f","status_error_code":356}}}}}}},"/sales/payme_sale_id/3ds/hash":{"get":{"security":[{"merchantKey":[]}],"operationId":"get-sales-payme-sale-id-3ds-hash","summary":"Resolve Secured Hash","tags":["Standalone 3D Secure service"],"description":"This end-point is used for our MPI / 3D secure as-a-service funtionality. \n\nYou can use this endpoint in order to resolve the secured hash sent from PayMe.\n","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"The MPL of the seller.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the action (0 - success)"},"xid":{"type":"string","description":"The XID generated by the credit card issuer"},"eci":{"type":"string","description":"The ECI generated by the credit card issuer"},"cavv":{"type":"string","description":"The CAVV generated by the credit card issuer"},"payme_sale_id":{"type":"string","description":"PayMe unique sale ID"}},"required":["status_code"]},"example":{"status_code":0,"xid":"NjZjYzUyZDJmMDQ0NDEzN2FiNGE=","eci":"05","cavv":"AAACBDaFQCAjBBUAJ4VAAAAAAAA=","payme_sale_id":"SALE1587-486438YT-JLHBOZLR-AJJTULHT"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the action (0 - success, 1 - failure)"},"payme_sale_id":{"type":"string","description":"PayMe unique sale ID"}}},"example":{"status_code":1,"status":"N","payme_sale_id":"SALE1587-486438YT-JLHBOZLR-AJJTULHT"}}}},"400":{"description":"Bad Request","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (1 - failure)\n\n"},"status_error_details":{"type":"string","description":"Error message\n\n"},"status_additional_info":{"type":"string","description":"Additional error information\n\n"},"status_error_code":{"type":"number","description":"Our unique error code\n\n"}}},"example":{"status_code":1,"status_error_details":"Validation error","status_additional_info":"eyJpdiI6Ilp...","status_error_code":20}}}}}}},"/documents":{"post":{"operationId":"post-create-invoice","summary":"Create Document","tags":["Invoices"],"description":"## Overview\n\nYou can use our Invoices API to generate different documents to serve your business needs.\n\n#### Document types\nThe documents you can generate can be found in the following guide - [Document Types](/marketplaces-and-platforms/lists-statuses/document-types).\n   \n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"doc_type":{"type":"number","description":"The documents you can generate can be found in the following guide - [Document Types](/marketplaces-and-platforms/lists-statuses/document-types)."},"buyer_name":{"type":"string","description":"Buyer's full name"},"due_date":{"type":"string","description":"Payment due date"},"pay_date":{"type":"string","description":"The date the payment was completed (relevant for doc_type"},"doc_date":{"type":"string","description":"Document creation date"},"currency":{"type":"string","description":"The currency of the document"},"doc_title":{"type":"string","description":"The title of the document (header) "},"doc_comments":{"type":"string","description":"Document description "},"exchange_rate":{"type":"number","description":"Currency exchange rate "},"vat_rate":{"type":"number","description":"The VAT (Value Added Tax) rate applied"},"total_excluding_vat":{"type":"number","description":"Total amount before VAT applied"},"discount":{"type":"number","description":"The discount rate (percentage) applied to the document"},"total_sum_after_discount":{"type":"number","description":"Total amount with discount rate included "},"total_sum_after_discount - copy":{"type":"number","description":"Total amount with discount rate included "},"total_sum_including_vat":{"type":"number","description":"Total amount including VAT"},"total_paid":{"type":"number","description":"Total amount paid in this document"},"total_vat":{"type":"number","description":"Total VAT paid "},"language":{"type":"string","description":"Document language"},"items":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description for item #1 "},"unit_price":{"type":"number","description":"The price per unit (1 item) \n\n`unit_price` or `unit_price_with_vat` is required."},"vat_exempt":{"type":"boolean","description":"VAT exempt for the document"},"quantity":{"type":"number","description":"Item #1 quantity"},"unit_price_with_vat":{"type":"number","description":"Unit (item) price including VAT"},"currency":{"type":"string","description":"Currency for item #1\n\nSale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"exchange_rate":{"type":"number","description":"Exchange rate for the document"}},"required":["description","unit_price"]}},"total_paid_including_vat":{"type":"number","description":"Total amount paid including VAT"},"cheques":{"type":"array","description":"The amount paid using a Cheque","items":{"type":"object","properties":{"sum":{"type":"number","description":"The amount paid using Cheque"},"date":{"type":"string","description":"Cheque deposit date"},"bank":{"type":"number","description":"The bank number - You can check the [list of banks](/marketplaces-and-platforms/lists-statuses/banks-in-israel) for your convenience."},"branch":{"type":"number","description":"The bank branch number"},"account":{"type":"string","description":"The bank account number"},"number":{"type":"string","description":"The Cheque number"}},"required":["sum"]}},"cash":{"type":"object","description":"The cash method object","properties":{"sum":{"type":"number","description":"The total amount paid using Cash"}},"required":["sum"]},"bank_transfer":{"type":"object","description":"The bank transfer object ","properties":{"sum":{"type":"number","description":"Total amount paid using a bank transfer"},"date":{"type":"string","description":"The date the bank transfer was received"},"account":{"type":"string","description":"The bank account number"}},"required":["sum"]},"paypal":{"type":"object","description":"The PayPal method object","properties":{"sum":{"type":"number","description":"Total amount paid using Paypal"},"date":{"type":"string","description":"The date of when the payment was completed"},"transaction_id":{"type":"string","description":"The external transaction ID (received from Paypal)"},"buyer_name":{"type":"string","description":"The buyer's name"}},"required":["sum","date"]},"credit_card":{"type":"object","description":"The credit card object ","properties":{"sum":{"type":"number","description":"Total amount paid using a credit card"},"installments":{"type":"number","description":"The number of installments for the payment (1 min, 36 max) "},"first_payment":{"type":"number","description":"The amount paid in the 1st installment "},"buyer_key":{"type":"string","description":"If the invoice is paid using a token, buyer key is required"},"number":{"type":"string","description":"If paid without a token, card number is required"},"type":{"type":"string","description":"Card brand"},"cvv":{"type":"string","description":"Card's CVV (3-number code at the back of the card)"},"expiry":{"type":"string","description":"Expiry date of the card (MMYY)"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number"},"buyer_name":{"type":"string","description":"Buyer's full name"},"auth_number":{"type":"string","description":"Authorization number of the payment"}},"required":["sum"]}},"required":["doc_type","buyer_name","currency","cash","bank_transfer"]},"example":{"doc_type":400,"buyer_name":"John Doe","due_date":"2021-08-16T00:00:00.000Z","pay_date":"2021-04-16T00:00:00.000Z","doc_date":"2021-05-25 00:00:00","currency":"ILS","doc_title":"Invoice for John Doe","doc_comments":"Some description about the invoice","exchange_rate":1,"vat_rate":0.17,"total_excluding_vat":123,"discount":0,"total_sum_after_discount":123,"total_sum_including_vat":140,"total_paid":140,"total_vat":17,"total_paid_including_vat":140,"language":"he","items":[{"description":"Test Item 1","unit_price":100,"vat_exempt":false,"quantity":1,"unit_price_with_vat":117,"currency":"ILS","exchange_rate":1},{"description":"Test Item 2","unit_price":23,"vat_exempt":true,"quantity":1,"currency":"ILS"}],"cheques":[{"sum":10,"date":"2021-05-16T00:00:00.000Z","bank":6,"branch":22,"account":"123456","number":"0014555"},{"sum":13,"date":"2021-06-16T00:00:00.000Z","bank":6,"branch":22,"account":"123456","number":"0014555"}],"cash":{"sum":25},"bank_transfer":{"sum":25,"date":"2021-05-16T00:00:00.000Z","account":"123456"},"paypal":{"sum":25,"date":"2021-05-16T00:00:00.000Z","transaction_id":"123456","buyer_name":"John Doe"},"credit_card":{"sum":25,"installments":1,"first_payment":50,"buyer_key":"123456789","number":"4580458045804580","type":"Visa","cvv":"123","expiry":"0323","buyer_social_id":"05001234","buyer_name":"John Doe","auth_number":"123123123"}}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"},"doc_type":{"type":"string","description":"The documents you can generate can be found in the following guide - [Document Types](/marketplaces-and-platforms/lists-statuses/document-types)."},"language":{"type":"string","description":"Changes the language of the payment IFRAME to English, as well as the error messages. Default value is Hebrew (he)"},"due_date":{"type":"string","description":"The date on which a seller expects to receive payment from a buyer"},"pay_date":{"type":"string","description":"Payment date"},"doc_date":{"type":"string","description":"The date of document creation"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"vat_rate":{"type":"number","description":"The VAT (Value Added Tax) rate applied."},"discount":{"type":"number","description":"The discount rate (percentage) applied to the document"},"total_vat":{"type":"number","description":"Total VAT paid"},"doc_title":{"type":"string","description":"The title of the document (header)"},"buyer_name":{"type":"string","description":"The buyer's name"},"total_paid":{"type":"number","description":"Total amount paid in this document"},"doc_comments":{"type":"string","description":"Document description"},"exchange_rate":{"type":"number","description":"Currency exchange rate"},"total_excluding_vat":{"type":"number","description":"Total amount before VAT applied"},"total_sum_including_vat":{"type":"number","description":"Total amount including VAT"},"total_sum_after_discount":{"type":"number","description":"Total amount with discount rate included"},"total_paid_including_vat":{"type":"number","description":"Total amount paid including VAT"},"cash":{"type":"object","description":"The cash method object","properties":{"sum":{"type":"number","description":"The total amount paid using Cash"}}},"cheques":{"type":"array","description":"The amount paid using a Cheque","items":{"type":"object","properties":{"sum":{"type":"number","description":"The amount paid using Cheque"},"date":{"type":"string","description":"Cheque deposit date"},"bank":{"type":"number","description":"The bank number - You can check the [list of banks](/marketplaces-and-platforms/lists-statuses/banks-in-israel) for your convenience."},"branch":{"type":"number","description":"The bank branch number"},"account":{"type":"string","description":"The bank account number"},"number":{"type":"string","description":"The Cheque number"}}}},"bank_transfer":{"type":"object","description":"The bank transfer object","properties":{"sum":{"type":"number","description":"Total amount paid using a bank transfer"},"date":{"type":"string","description":"The date the bank transfer was received"},"account":{"type":"string","description":"The bank account number"}}},"credit_card":{"type":"object","description":"The credit card object","properties":{"sum":{"type":"number","description":"Total amount paid using a credit card"},"installments":{"type":"number","description":"The number of installments for the payment (1 min, 36 max)"},"first_payment":{"type":"number","description":"The amount paid in the 1st installment"},"number":{"type":"string","description":"If paid without a token, card number is required"},"type":{"type":"string","description":"Card brand"},"cvv":{"type":"string","description":"Card's CVV (3-number code at the back of the card)"},"buyer_social_id":{"type":"string","description":"Buyer's social ID number"},"buyer_name":{"type":"string","description":"Buyer's full name"},"auth_number":{"type":"string","description":"Authorization number of the payment"},"expiry":{"type":"string","description":"Expiry date of the card (MMYY)"}}},"paypal":{"type":"object","description":"The PayPal method object","properties":{"sum":{"type":"number","description":"Total amount paid using Paypal"},"date":{"type":"string","description":"The date of when the payment was completed"},"transaction_id":{"type":"string","description":"The external transaction ID (received from Paypal)"},"buyer_name":{"type":"string","description":"The buyer's name"}}},"items":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number","description":"Item #1 quantity"},"description":{"type":"string","description":"Description for item #1"},"unit_price":{"type":"number","description":"The price per unit (1 item)"},"vat_exempt":{"type":"boolean","description":"VAT exempt for the document"},"currency":{"type":"string","description":"Currency for item #1\n\nSale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"unit_price_with_vat":{"type":"number","description":"Unit (item) price including VAT"},"exchange_rate":{"type":"number","description":"Exchange rate for the document"}}}},"doc_id":{"type":"string","description":"Document ID number\n"},"doc_url":{"type":"string","description":"Document URL "}}},"example":{"status_code":0,"doc_type":"400","language":"he","due_date":"2021-08-16T00:00:00.000Z","pay_date":"2021-04-16T00:00:00.000Z","doc_date":"2021-05-25 00:00:00","currency":"ILS","vat_rate":0.17,"discount":0,"total_vat":17,"doc_title":"Invoice for John Doe","buyer_name":"John Doe","total_paid":140,"doc_comments":"Some description about the invoice","exchange_rate":1,"total_excluding_vat":123,"total_sum_including_vat":140,"total_sum_after_discount":123,"total_paid_including_vat":140,"cash":{"sum":25},"cheques":[{"sum":10,"date":"2021-05-16T00:00:00.000Z","bank":6,"branch":22,"account":"123456","number":"0014555"},{"sum":13,"date":"2021-06-16T00:00:00.000Z","bank":6,"branch":22,"account":"123456","number":"0014555"}],"bank_transfer":{"sum":25,"date":"2021-05-16T00:00:00.000Z","account":"123456"},"credit_card":{"sum":0,"installments":1,"first_payment":50,"number":"4580458045804580","type":"Visa","cvv":"123","buyer_social_id":"05001234","buyer_name":"John Doe","auth_number":"123123123","expiry":"323"},"paypal":{"sum":50,"date":"2021-05-16T00:00:00.000Z","transaction_id":"123456","buyer_name":"John Doe"},"items":[{"quantity":1,"description":"Test Item 1","unit_price":100,"vat_exempt":false,"currency":"ILS","unit_price_with_vat":117,"exchange_rate":1},{"quantity":1,"description":"Test Item 2","unit_price":23,"vat_exempt":true,"currency":"ILS"}],"doc_id":"fa397fce-aee6-4c6d-ae9c-273ae1e3a317","doc_url":"https://invoice-staging.paymeservice.com/documents/fa397fce-aee6-4c6d-ae9c-273ae1e3a317"}}}},"400":{"description":"Bad Request","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"object","properties":{"doc_type":{"type":"array"},"items":{"type":"array"},"buyer_name":{"type":"array"}}},"status_error_code":{"type":"number"}}},"example":{"status_code":1,"status_error_details":"The given data was invalid.","status_additional_info":{"doc_type":["The doc type field is required."],"items":["The items field is required."],"buyer_name":["The buyer name field is required."]},"status_error_code":20}}}}}},"get":{"security":[{"merchantKey":[]}],"operationId":"get-documents","summary":"Query Existing Documents","tags":["Invoices"],"description":"## Overview\n\nIn order to query for existing documents, you will need to use the following endpoint and parameters:\n \nEnvironment | URL\n---|---\n`Sandbox`| `https://sandbox.payme.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n`Production` | `https://live.payme.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n\n##### Header\nParameter | Description \n---|---\n`PayMe-Merchant-Key` | Seller's MPL `MPL00006-00006EXM-EXAMPLE0-EXAMPLE6`\n\n  \n","parameters":[{"name":"page","in":"query","required":false,"description":"How many pages should be included in the query","schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"description":"How many documents per extraction","schema":{"type":"number"}},{"name":"field","in":"query","required":false,"description":"The dates the query is for","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"The order of documents ","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"schema":{"type":"string"}}],"responses":{}}},"/documents/document_id":{"get":{"security":[{"merchantKey":[]}],"operationId":"show-generated-document-by-id","summary":"Get Generated Document By ID","tags":["Invoices"],"description":"## Overview\n\nIn order to query for existing documents, you will need to use the following endpoint and parameters:\n \nEnvironment | URL\n---|---\n`Sandbox`| `https://sandbox.payme.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n`Production` | `https://live.payme.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n\n##### Header\nParameter | Description \n---|---\n`PayMe-Merchant-Key` | Seller's MPL `DEMOMPL-DEMOMPL-DEMOMPL-DEMOMPL-`\n\n### Request Example:\n\nItem | Description | Example\n---|---|---\nURL | `https://sandbox.payme.io/api/documents/{document_ID}` |  `INV12321*****`\nHeader| `seller_payme_id` | `MPLDEMO-MPLDEMO-MPLDEMO-MPLDEMO`","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{}}},"/show-documents/document_id":{"get":{"security":[{"merchantKey":[]}],"operationId":"show-generated-document-by-id-2","summary":"Show Generated Document By ID","tags":["Invoices"],"description":"## Overview\n\nIn order to query for existing documents, you will need to use the following endpoint and parameters:\n \nEnvironment | URL\n---|---\n`Staging`| `https://sandbox.paymes.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n`Production` | `https://live.paymes.io/api/documents?page=0&limit=5&field=createdAt&sort=desc`\n\n##### Header\nParameter | Description \n---|---\n`PayMe-Merchant-Key` | Seller's MPL `DEMOMPL-DEMOMPL-DEMOMPL-DEMOMPL-`\n\n### Request Example:\n\nItem | Description | Example\n---|---|---\nURL | `https://sandbox.payme.io/api/show-documents/{document_ID}` |  `INV12321*****`\nHeader| `seller_payme_id` | `MPLDEMO-MPLDEMO-MPLDEMO-MPLDEMO`","parameters":[{"name":"PayMe-Merchant-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{}}},"/get-sales":{"post":{"operationId":"post-get-sales","summary":"List Sales","tags":["Query APIs"],"description":"## Overview\n\nYou can retreive data on different sales processed by your sellers using this endpoint. \n\n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe partner key. Only partners (platforms managing many sellers) have one; a merchant authenticates with seller_payme_id alone. Can also be sent in the PayMe-Partner-Key header."},"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\n\nIf you are a partner, you can use multiple seller_payme_id attributes to retreive data for these specific sellers"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"sale_payme_code":{"type":"string","description":"Our unique sale code"},"sale_payme_id":{"type":"string","description":"Our unique sale ID"},"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_created":{"type":"string","description":"Exact creation date and time for which to retrieve sales. ISO-8601 formatted"},"sale_created_min":{"type":"string","description":"Earliest creation date and time for which to retrieve sales. ISO-8601 formatted"},"sale_created_max":{"type":"string","description":"Latest date and time for which to retrieve sales. ISO-8601 formatted"},"sale_status":{"type":"string","description":"Sale status. All statuses are available [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses).\n\nFor multiple statuses use array format like` [\"initial\",\"validated\"]`\n"},"sale_price":{"type":"number","description":"Sale final price.\n\nFor example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075"},"sale_currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"sale_auth_number":{"type":"string","description":"Sale authorization number from the credit company"},"buyer_card_mask":{"type":"string","description":"Buyer's credit card mask"},"buyer_card_last_four_digits":{"type":"string","description":"Buyer's credit card last four digits"},"buyer_email":{"type":"string","description":"Buyer's eMail address"},"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 social id\n(For Israeli sellers only)"},"buyer_card_is_foreign":{"type":"boolean","description":"Is the buyer's credit card foreign"}}},"example":{"payme_client_key":"XXXXXXXX","transaction_id":"12345"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items_count":{"type":"number","description":"Number of items"},"items":{"type":"array","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"sale_payme_id":{"type":"string","description":"Our unique sale ID"},"sale_payme_code":{"type":"string","description":"Our unique 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_created":{"type":"string","description":"Exact creation date and time for which to retrieve sales. ISO-8601 formatted"},"sale_status":{"type":"string","description":"Sale status. All available Sale statuses"},"sale_currency":{"type":"string","description":"Currency the transaction was processed in"},"sale_price":{"type":"number","description":"Sale final price. For example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075"},"sale_price_after_fees":{"type":"number","description":"Sale amount including fees"},"sale_description":{"type":"string","description":"What was the goods/services the buyer paid for"},"sale_installments":{"type":"number","description":"Number of installments used for the purchase`"},"sale_vat":{"type":"string","description":"VAT added to the sale"},"sale_paid_date":{"type":"string","description":"The date the sale was paid "},"sale_auth_number":{"type":"string","description":"Sale authorization number from the credit company"},"sale_release_date":{"type":"string","description":"The expected date the funds will be available in the seller's balance"},"sale_fees":{"type":"object","properties":{"sale_processing_fee":{"type":"string","description":"Total processing fee"},"sale_processing_charge":{"type":"string","description":"Processing charge"},"sale_discount_fee":{"type":"string","description":"Discount fee"},"sale_rapid_settlement_fee":{"type":"string","description":"Rapid settlement fee"},"sale_market_fee":{"type":"string","description":"Sale's market fee"}}},"sale_buyer_details":{"type":"object","properties":{"buyer_card_mask":{"type":"string","description":"Buyer's credit card mask\n\n"},"buyer_card_expiry":{"type":"string","description":"Expiration date"},"buyer_card_brand":{"type":"string","description":"Card brand"},"buyer_card_is_foreign":{"type":"boolean","description":"Card is foreign or domestic\n'true' for foreign, 'false' for domestic."},"buyer_name":{"type":"string","description":"Buyer's first and last name"},"buyer_email":{"type":"string","description":"Buyer's email"},"buyer_phone":{"type":"string","description":"Buyer's phone"},"buyer_social_id":{"type":"string","description":"Buyer's social ID"}}},"sale_invoices":{"type":"array","description":"Invoice generated unique ID"}}}},"status_code":{"type":"number","description":"0 for Sucessful requests, 1 for Failed requests"}}},"example":{"items_count":1,"items":[{"seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_id":"12345","sale_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","sale_payme_code":"12345678","transaction_id":"12345","sale_created":"2016-01-01 15:15:15","sale_status":"completed","sale_currency":"USD","sale_price":10000,"sale_price_after_fees":8970,"sale_description":"A duck","sale_installments":1,"sale_vat":"0.17","sale_paid_date":"2016-01-01 15:16:15","sale_auth_number":"01A2B3C","sale_release_date":"2016-01-08 15:15:15","sale_error_code":"","sale_error_text":"","sale_fees":{"sale_processing_fee":"3.50","sale_processing_charge":"1.20","sale_discount_fee":"0.50","sale_rapid_settlement_fee":"0.30","sale_market_fee":"0.00"},"sale_buyer_details":{"buyer_card_mask":"458045******4580","buyer_card_expiry":"1022","buyer_card_brand":"Visa","buyer_card_is_foreign":true,"buyer_name":"First Last","buyer_email":"buyer@example.com","buyer_phone":"0500000001","buyer_social_id":"000000001"},"sale_invoices":[]}],"status_code":0}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":1,"status_error_details":"שירות לא נמצא","status_additional_info":"payme_client_key","status_error_code":200}}}}}}},"/get-transactions":{"post":{"operationId":"post-get-transactions","summary":"List Transactions","tags":["Query APIs"],"description":"## Overview\n\nYou can retreive data on different transactions processed by your sellers using this endpoint.\n\n#### Filtering\nIn order to filter by transaction type, use the following method:\nParameter name|Description\n---|---\n`transaction_status` | The applicable transaction statuses. \n\nYou can find the transaction statuses in the following guide - [Transaction Statuses](/marketplaces-and-platforms/lists-statuses/transaction-statuses).\n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```\n\n\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\n\nIf you are a partner, you can use multiple seller_payme_id attributes to retreive data for these specific sellers.\n\nIn this case you need to send also payme_client_key."},"transaction_type":{"type":"number","description":"Transaction type can be found [Transaction Types](/marketplaces-and-platforms/lists-statuses/transaction-types)"},"transaction_status":{"type":"string","description":"All transaction statuses can be found [Transaction Statuses](/marketplaces-and-platforms/lists-statuses/transaction-statuses)"},"sale_status":{"type":"string","description":"Sale Status can be found [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses)\r\n\n\nExample: `completed`"},"sale_currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217).\r\n\n\nExample: `ILS`"},"sale_payment_method":{"type":"string","description":"Sale Payment Method (for the list see [Payment Methods](/payments/direct-api/available-payment-methods))\r\n\n\nExample: `credit-card`"},"transaction_created_min":{"type":"string","description":"Earliest creation date and time for which to retrieve transactions. ISO-8601 formatted"},"transaction_created_max":{"type":"string","description":"Latest date and time for which to retrieve transactions. ISO-8601 formatted\r\n\r\n"},"transaction_created_at":{"type":"string","description":"Transaction creation date and time for which to retrieve transactions. ISO-8601 formatted"},"transaction_id":{"type":"string","description":"Merchant's unique sale ID for correlation with us"},"payme_transaction_id":{"type":"string","description":"PayMe's unique transaction ID"},"transaction_price":{"type":"number","description":"The transaction price amount in cents"},"sale_price":{"type":"number","description":"The sale price amount in cents"},"sale_auth_number":{"type":"string","description":"Sale authorization number from the credit company"},"buyer_card_mask":{"type":"string","description":"Buyer's credit card mask"},"buyer_name":{"type":"string","description":"Buyer's full name"},"buyer_phone":{"type":"string","description":"Buyer's phone"},"buyer_social_id":{"type":"string","description":"Buyer's social ID"},"buyer_card_is_foreign":{"type":"boolean","description":"Indicates if the card is foreign"},"buyer_card_last_four_digits":{"type":"string","description":"Buyer's credit card last four digits"},"sale_is_3ds":{"type":"boolean","description":"In case the sale is with 3DS"},"transaction_is_matched":{"type":"boolean","description":"Indicates if the transaction is correlated."}},"required":["seller_payme_id"]},"example":{"seller_payme_id":"MPL90007-90007EXM-EXAMPLE0-EXAMPLE9","transaction_type":1,"transaction_status":"chargeback-refund","sale_status":["chargeback"],"sale_currency":["ILS"],"sale_payment_method":["credit-card"],"time":["2021-08-05"]}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID\r\n\r\n"},"seller_id":{"type":"integer","description":"Merchant's unique seller ID for correlation with us\r\n\r\n"},"sale_payme_id":{"type":"string","description":"Our unique sale ID\r\n\r\n"},"sale_payme_code":{"type":"number","description":"Our unique sale code\r\n\r\n"},"transaction_id":{"type":"string","description":"Merchant's unique sale ID for correlation with us\r\n"},"payme_transaction_id":{"type":"string","description":"PayMe's unique transaction ID"},"transaction_created_at":{"type":"string","description":"Exact creation date and time for which to retrieve transaction. ISO-8601 formatted\r\n\r\n"},"sale_type":{"type":"number","description":"Sale type. All available Sale types can be found [Sale Types](/marketplaces-and-platforms/lists-statuses/sale-types)"},"sale_status":{"type":"string","description":"Sale status. All available Sale statuses can be found [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses)\r\n"},"transaction_status":{"type":"string","description":"Transaction status. All available transaction statuses can be found [Transaction Statuses](/marketplaces-and-platforms/lists-statuses/transaction-statuses)\r\n"},"transaction_type":{"type":"number","description":"Transaction type. All available transaction types can be found [Transaction Types](/marketplaces-and-platforms/lists-statuses/transaction-types)\r\n"},"sale_currency":{"type":"string","description":"Currency the transaction was processed in"},"sale_description":{"type":"string","description":"What was the goods/services the buyer paid for\r\n\r\n"},"sale_installments":{"type":"number","description":"Number of installments used for the purchase`\r\n\r\n"},"sale_payment_method":{"type":"string","description":"The Payment method used to pay the sale.\n\nFor all the payment methods see [Available Payment Methods](/payments/direct-api/available-payment-methods)."},"transaction_price":{"type":"number","description":"The price amount"},"transaction_price_after_fees":{"type":"string","description":"Transaction amount including fees\r\n\r\n"},"sale_vat":{"type":"string","description":"VAT added to the sale\r\n\r\n"},"sale_auth_number":{"type":"string","description":"Sale authorization number from the credit company\r\n\r\n"},"transaction_release_date":{"type":"string","description":"The expected date the funds will be available in the seller's balance\r\n\r\n"},"transaction_voucher":{"type":"string","description":"PayMe's transaction voucher"},"transaction_reference_number":{"type":"string","description":"Transaction reference number received from gateway."},"transaction_action":{"type":"string","description":"The action that was taken on the transaction.\n\nPossible values: Authorize, Tokenize, Detokenize, Debit, Capture, Refund, PartialRefund, Chargeback, ChargebackRefund, Void, PartialVoid, PartialChargeback, PartialChargebackRefund "},"transaction_first_payment":{"type":"number","description":"Transaction first payment amount, or total amount if there are no installements."},"transaction_periodical_payment":{"type":"number","description":"Transaction periodical payment amount in case of installements."},"transaction_arn":{"type":"string","description":"Acquirer Reference Numbers"},"transaction_acquirer":{"type":"string","description":"Transaction acquirer"},"transaction_discounter":{"type":"string","description":"Transaction discounter entity"},"transaction_error_code":{"type":"number","description":"In case of failure, the transaction error code.\n\nIf transaction was successful error code will be 20000."},"transaction_error_text":{"type":"string","description":"The error code description."},"transaction_is_matched":{"type":"boolean","description":"Indicates if the transaction is correlated."},"transaction_match_statuses":{"type":"array","description":"If transaction is matched, indicates the relevant matched statuses."},"transaction_is_canceled":{"type":"boolean","description":"Indicates if the transaction was canceled before transmitted."},"sale_is_3ds":{"type":"boolean","description":"In case the sale is with 3DS"},"sale_fees":{"type":"object","properties":{"sale_processing_fee":{"type":"string","description":"Processing fee\r\n\r\n"},"sale_processing_fee_total":{"type":"number","description":"Total processing fee\r\n\r\n\r\n"},"sale_processing_charge":{"type":"string","description":"Processing charge\r\n\r\n"},"sale_discount_fee":{"type":"string","description":"Discount fee\r\n\r\n"},"sale_discount_fee_total":{"type":"number","description":"Total Discount fee\r\n"},"sale_rapid_settlement_fee":{"type":"string","description":"Rapid settlement fee\r\n\r\n"},"sale_rapid_settlement_fee_total":{"type":"number","description":"Total Rapid settlement fee\r\n"},"sale_annual_interest_rate":{"type":"string","description":"The annual interest rate (precentage) of the rapid and discount settlements"},"sale_market_fee":{"type":"string","description":"Sale's market fee\r\n\r\n"},"sale_market_fee_total":{"type":"number","description":"Total sale's market fee\r\n"}}},"sale_buyer_details":{"type":"object","properties":{"buyer_card_mask":{"type":"string","description":"Buyer's credit card mask\r\n\r\n"},"buyer_card_expiry":{"type":"string","description":"Expiration date\r\n\r\n"},"buyer_card_brand":{"type":"string","description":"Card brand\r\n\r\n"},"buyer_card_is_foreign":{"type":"boolean","description":"Indicates if the card is foreign"},"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\r\n\r\n"},"buyer_social_id":{"type":"string","description":"Buyer's social ID\r\n\r\n"}}},"transaction_invoice_url":{"type":"string","description":"Link to the invoice"},"transaction_invoice_doc_number":{"type":"string","description":"The invoice number."}}},"example":{"seller_payme_id":"MPL00008-00008EXM-EXAMPLE0-EXAMPLE8","seller_id":null,"sale_payme_id":"SALE1499-869577YG-Y2QXJ6PK-INXR2FAE","sale_payme_code":115498,"transaction_id":"","payme_transaction_id":"TRAN1499-869602B9-7QIUNKHI-F0SL1AOV","transaction_created_at":"2017-07-12 17:26:42","sale_type":1,"sale_status":"completed","transaction_status":"validated","transaction_type":1,"sale_currency":"ILS","sale_description":"produt","sale_installments":5,"sale_payment_method":"credit-card","transaction_price":9000,"transaction_price_after_fees":"8617","sale_vat":"0.17","sale_auth_number":"2154577","transaction_release_date":"2017-08-01 06:00:00","transaction_voucher":"10784","transaction_reference_number":null,"transaction_acquirer":null,"transaction_discounter":null,"transaction_error_code":"20000","transaction_error_text":"Permitted transaction","transaction_is_matched":false,"transaction_match_statuses":[],"sale_is_3ds":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_yearly_interest_fee":null,"sale_market_fee":"0.00","sale_market_fee_total":0},"sale_buyer_details":{"buyer_card_mask":"458000******0000","buyer_card_expiry":"0521","buyer_card_brand":0,"buyer_card_is_foreign":false,"buyer_name":"Adam Kogan","buyer_email":"user4@example.com","buyer_phone":"0500000004","buyer_social_id":"310048889"},"transaction_invoice_url":null}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":1,"status_error_details":"Please verify that the JSON provided is valid","status_additional_info":null,"status_error_code":901}}}}}}},"/get-subscriptions":{"post":{"operationId":"post-get-subscriptions","summary":"List Subscriptions","tags":["Query APIs"],"description":"## Overview\n\nYou can retreive data on subscriptions processed by your sellers using this endpoint. \n\nTo understand the different use-cases for this API, See Get Subscriptions API guide [here](https://docs.paymeservice.com/docs/payme-public/b3A6MjU2MDk2MjE-get-sales). \n\n\n#### Subscription Iteration Types\nYou can find them in the following guide - [Subscription Iteration Types](/marketplaces-and-platforms/lists-statuses/subscription-iteration-types).\n\n#### Subscription Statuses\nYou can find them in the following guide - [Subscription Statuses](/marketplaces-and-platforms/lists-statuses/subscription-statuses).\n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key"},"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\n\nIf you are a partner, you can use multiple seller_payme_id attributes to retreive data for these specific sellers"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"sub_payme_code":{"type":"string","description":"Our unique subscription code"},"sub_payme_id":{"type":"string","description":"Our unique sub ID"},"sub_created":{"type":"string","description":"Exact creation date and time for which to retrieve subscriptions. ISO-8601 formatted"},"sub_created_min":{"type":"string","description":"Earliest creation date and time for which to retrieve subscriptions. ISO-8601 formatted"},"sub_created_max":{"type":"string","description":"Latest date and time for which to retrieve subscriptions. ISO-8601 formatted"},"sub_status":{"type":"string","description":"Subscription status.\n\nYou can find them in the following guide - [Subscription Statuses](/marketplaces-and-platforms/lists-statuses/subscription-statuses)."},"sub_iteration_type":{"type":"number","description":"Subscription type ID.\n\nYou can find them in the following guide - [Subscription Iteration Types](/marketplaces-and-platforms/lists-statuses/subscription-iteration-types)."},"sub_price":{"type":"number","description":"Subscription final price. For example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075"},"sub_currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"sub_iterations":{"type":"number","description":"Subscription amount of iterations"},"sub_start_date":{"type":"string","description":"Exact start date and time for which to retrieve subscriptions. ISO-8601 formatted"},"sub_paid":{"type":"boolean","description":"Was the subscription paid or not"}},"required":["payme_client_key"]},"example":{"payme_client_key":"XXXXXXXX","sub_payme_code":"1234"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items_count":{"type":"number","description":"Number of subscription"},"items":{"type":"array","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"sub_payme_id":{"type":"string","description":"Our unique sub ID"},"payme_sub_code":{"type":"number","description":"Our unique subscription code"},"sub_created":{"type":"string","description":"Exact creation date and time for which to retrieve subscriptions. ISO-8601 formatted"},"sub_start_date":{"type":"string","description":"Exact state date and time for which the subscription will be initiated\n"},"sub_status":{"type":"string","description":"Subscription status (for more info about the statuses, see table below)"},"sub_iteration_type":{"type":"number","description":"Subscription type ID (for more info about the types, see table [Subscription Iteration Types](/marketplaces-and-platforms/lists-statuses/subscription-iteration-types))"},"sub_price":{"type":"number","description":"Subscription final price. For example, if the price is 50.75 (max 2 decimal points) the value that needs to be sent is 5075"},"sub_description":{"type":"string","description":"Brief description about the subscription"},"sub_iterations":{"type":"string","description":"Subscription amount of iterations"},"sub_iterations_completed":{"type":"string","description":"Number of iterations completed"},"sub_iterations_left":{"type":"string","description":"Number of iterations left for the subscription"},"sub_payment_date":{"type":"string","description":"The date the payment is completed for each iteration"},"sub_error_text":{"type":"string","description":"If an error occured, it'll be mentioned in this parameter"},"sub_currency":{"type":"string","description":"Currency of subscription"},"sub_paid":{"type":"boolean","description":"Was the subscription paid"},"sub_buyer_details":{"type":"object","properties":{"buyer_card_mask":{"type":"string","description":"The first 6 and last 4 digits of the used card for the subscription"},"buyer_name":{"type":"string","description":"Buyer's first and last 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 social ID number"}}}}}},"status_code":{"type":"number","description":"Status of the request (0 - success, 1 - error)"}}},"example":{"items_count":1,"items":[{"seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_id":"12345","sub_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","sub_payme_code":"1234","sub_created":"2016-01-01 15:15:15","sub_start_date":"2016-01-10 08:00:00","sub_prev_date":null,"sub_next_date":null,"sub_status":"2","sub_iteration_type":"3","sub_price":"10000","sub_description":"Monthly Test Subscription","sub_iterations":"4","sub_iterations_completed":"0","sub_iterations_left":"4","sub_payment_date":"2016-01-02 10:10:10","sub_error_text":"","sub_currency":"USD","sub_paid":true,"sub_buyer_details":{"buyer_card_mask":"458045******4580","buyer_name":"First Last","buyer_email":"buyer@example.com","buyer_phone":"0500000001","buyer_social_id":"000000001"}}],"status_code":0}}}}}}},"/get-sellers":{"post":{"operationId":"post-get-sellers","summary":"List Sellers","tags":["Query APIs"],"description":"## Overview\n\nYou can retreive data on your sellers using this endpoint.\n\n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key"},"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\n\nIf you are a partner, you can use multiple seller_payme_id attributes to retreive data for these specific sellers"},"seller_created_max":{"type":"string","description":"Latest date and time for which to retrieve sellers. ISO-8601 formatted"},"seller_created_min":{"type":"string","description":"Earliest creation date and time for which to retrieve sellers. ISO-8601 formatted"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"seller_first_name":{"type":"string"},"seller_last_name":{"type":"string","description":"First name of the account owner"},"seller_social_id":{"type":"string","description":"Last name of the account owner"},"seller_email":{"type":"string","description":"Seller's personal email"},"seller_phone":{"type":"string","description":"Seller's personal phone"},"seller_contact_email":{"type":"string","description":"Seller's contact email that will be displayed to the buyers"},"seller_contact_phone":{"type":"string","description":"Seller's contact phone that will be displayed to the buyers"},"seller_inc":{"type":"string"},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ)"},"selelr_merchant_name":{"type":"string","description":"Seller's merchant name"},"market_fee":{"type":"number","description":"A decimal between 0-30 representing the percent of the sale price that is collected for the marketplace (includes VAT)"},"seller_active":{"type":"boolean","description":"Seller's active state"},"seller_approved":{"type":"boolean","description":"Seller's approval state"}},"required":["payme_client_key"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_created_min":"2016-01-01 00:00:00","seller_created_max":"2016-01-02 00:00:00","seller_first_name":"First"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items_count":{"type":"number","description":"Number of sellers"},"items":{"type":"array","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL)"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"seller_created":{"type":"string","description":"Exact creation date and time for which to retrieve sellers. ISO-8601 formatted\n"},"seller_active":{"type":"boolean","description":"Seller is Active in the system or not"},"seller_approved":{"type":"boolean","description":"Seller is approved in the system (T/F)"},"seller_approved_date":{"type":"string","description":"The date the seller was approved in the system"},"seller_is_paid_directly":{"type":"boolean","description":"Seller is paid directly by PayMe or by the acquirers. (true is paid by the acquirers)\n"},"seller_is_discount":{"type":"boolean","description":"Seller has a discount rate"},"seller_withdrawal_plan":{"type":"number","description":"Seller withdrawl plan (see `get-withdrawls` API)\n"},"seller_withdrawal_date":{"type":"string"},"seller_personal_details":{"type":"object","properties":{"seller_first_name":{"type":"string","description":"First name of the account owner"},"seller_last_name":{"type":"string","description":"Last name of the account owner"},"seller_social_id":{"type":"string","description":"Seller's social ID number"},"seller_birthdate":{"type":"string","description":"Seller birth date"},"seller_gender":{"type":"string","description":"Seller gender (0 - Male, 1 - Female)"},"seller_email":{"type":"string","description":"Seller's email address`"},"seller_phone":{"type":"string","description":"Seller's phone number"}}},"seller_business_details":{"type":"object","properties":{"seller_inc":{"type":"string"},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ)"},"seller_merchant_name":{"type":"string","description":"Seller's merchant name"},"seller_site_url":{"type":"string","description":"Seller's website URL`"},"seller_description":{"type":"string","description":"Seller's business description"},"seller_retail_type":{"type":"string","description":"Seller retail type"},"seller_contact_email":{"type":"string","description":"Seller contact email"},"seller_contact_phone":{"type":"string","description":"Seller's contact phone"},"seller_bank_account_code":{"type":"string","description":"Seller bank code"},"seller_bank_account_branch":{"type":"string","description":"Seller's bank branch"},"seller_bank_account_number":{"type":"string","description":"Seller's bank account number"}}},"seller_address":{"type":"object","properties":{"seller_address_city":{"type":"string","description":"Seller's city address"},"seller_address_street":{"type":"string","description":"Seller's address street"},"seller_address_street_number":{"type":"string","description":"Seller's street address number"},"seller_address_country":{"type":"string","description":"Seller's country address"}}},"seller_fees":{"type":"object","properties":{"fee_market_fee":{"type":"string","description":"Market fee"},"fee_default_processing_fee":{"type":"string","description":"Partner's default processing fees"},"fee_default_processing_charge":{"type":"string","description":"Partner's default processing fees"},"fee_default_discount_fee":{"type":"string","description":"Partner's default discount"},"fee_foreign_processing_fee":{"type":"string","description":"Partner's default foreign cards processing fees"},"fee_foreign_processing_charge":{"type":"string","description":"Partner's default foreign processing charges"},"fee_forcurr_processing_charge":{"type":"string","description":"Partner's default foreign currency charges"}}},"seller_currencies":{"type":"array","description":"Seller enabled currencies"},"seller_wallets":{"type":"object","properties":{"ILS":{"type":"object","properties":{"wallet_currency":{"type":"string","description":"Currency of the seller's wallet "},"wallet_total":{"type":"string","description":"Wallet total balance"},"wallet_releasable":{"type":"string","description":"The balance available for settlement"}}},"USD":{"type":"object","description":"`","properties":{"wallet_currency":{"type":"string","description":"Wallet currency "},"wallet_total":{"type":"string","description":"Wallet total balance"},"wallet_releasable":{"type":"string","description":"The balance available for settlement"}}}}},"seller_monthly_invoices":{"type":"object","properties":{"1234":{"type":"object","properties":{"invoice_reference":{"type":"string","description":"Invoice reference number "},"invoice_created":{"type":"string","description":"Invoice creation date"},"invoice_doc_number":{"type":"string","description":"Invoice document number "},"invoice_url":{"type":"string","description":"Invoice file PDF URL"},"invoice_details_url":{"type":"string","description":"Invoice details URL"}}},"2134":{"type":"object","properties":{"invoice_reference":{"type":"string","description":"Invoice reference number "},"invoice_created":{"type":"string","description":"Invoice creation date"},"invoice_doc_number":{"type":"string","description":"Invoice document number "},"invoice_url":{"type":"string","description":"Invoice file PDF URL"},"invoice_details_url":{"type":"string","description":"Invoice details URL"}}}}}}}},"status_code":{"type":"number","description":"0 for Sucessful requests, 1 for Failed requests\r\n\r\n"}}},"example":{"items_count":1,"items":[{"seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_id":"12345","seller_created":"2016-01-01 15:15:15","seller_active":true,"seller_approved":false,"seller_approved_date":"2016-02-10 00:00:00","seller_is_paid_directly":false,"seller_is_discount":true,"seller_withdrawal_plan":1,"seller_withdrawal_date":null,"seller_personal_details":{"seller_first_name":"First","seller_last_name":"Last","seller_social_id":"999999999","seller_birthdate":"1989-05-06","seller_gender":"1","seller_email":"personal@example.com","seller_phone":"0500000005"},"seller_business_details":{"seller_inc":"2","seller_inc_code":"123456","seller_merchant_name":"Baby Ducks","seller_site_url":"www.babyducks.com","seller_description":"We are Baby Ducks","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":"12345"},"seller_address":{"seller_address_city":"City","seller_address_street":"Street","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_discount_fee":"0.50","fee_foreign_processing_fee":"3.50","fee_foreign_processing_charge":"1.20","fee_forcurr_processing_charge":"0.30"},"seller_currencies":["ILS","USD","EUR"],"seller_wallets":{"ILS":{"wallet_currency":"ILS","wallet_total":"10000","wallet_releasable":"0"},"USD":{"wallet_currency":"USD","wallet_total":"0","wallet_releasable":"0"}},"seller_monthly_invoices":{"1234":{"invoice_reference":"2015-12","invoice_created":"2016-01-01","invoice_doc_number":"1234","invoice_url":"PDF_FILE_URL.pdf","invoice_details_url":"https://preprod.paymeservice.com/system/invoice-details-viewer/XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"},"2134":{"invoice_reference":"2016-01","invoice_created":"2016-02-01","invoice_doc_number":"2134","invoice_url":"PDF_FILE_URL.pdf","invoice_details_url":"https://preprod.paymeservice.com/system/invoice-details-viewer/XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"}}}],"status_code":0}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"example":{"status_code":1,"status_error_details":"שירות לא נמצא","status_additional_info":"payme_client_key","status_error_code":200}}}}}}},"/get-withdrawals":{"post":{"operationId":"post-get-withdrawals","summary":"List Past Withdrawals","tags":["Query APIs"],"description":"## Overview\n\nYou can retreive data on withdrawals requested by your sellers using this endpoint. \n\n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key\n"},"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\nIf you are a partner, you can use multiple seller_payme_id attributes to retreive data for these specific sellers"},"seller_id":{"type":"string","description":"Merchant's unique seller ID for correlation with us"},"withdrawal_created":{"type":"string","description":"Exact creation date and time for which to retrieve withdrawals. ISO-8601 formatted"},"withdrawal_created_min":{"type":"string","description":"Earliest creation date and time for which to retrieve withdrawals. ISO-8601 formatted"},"withdrawal_created_max":{"type":"string","description":"Latest date and time for which to retrieve withdrawals. ISO-8601 formatted"},"withdrawal_total":{"type":"string","description":"Withdrawal total amount. For example, if the amount is 50.75 (max 2 decimal points) the value that recieved is 5075"},"withdrawal_currency":{"type":"string","description":"Withdrawal currency. 3-letter ISO 4217 name"}},"required":["payme_client_key"]},"example":{"payme_client_key":"XXXXXXXX","withdrawal_payme_code":"1234"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items_count":{"type":"number"},"items":{"type":"array","items":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID"},"withdrawal_payme_code":{"type":"number","description":"Unique withdrawl PayMe code"},"withdrawal_created":{"type":"string","description":"Withdrwal creation date"},"withdrawal_currency":{"type":"string","description":"Withdrawal currency. 3-letter ISO 4217 name"},"withdrawal_total":{"type":"number","description":"Withdrawl total amount"},"withdrawal_description":{"type":"string","description":"Withdrawl description "}}}},"status_code":{"type":"number"}}},"example":{"items_count":1,"items":[{"seller_payme_id":"XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX","withdrawal_payme_code":10001,"withdrawal_created":"2016-01-01 15:15:15","withdrawal_currency":"USD","withdrawal_total":600000,"withdrawal_description":"משיכה לבנק"}],"status_code":0}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"number"},"status_error_details":{"type":"string"},"status_additional_info":{"type":"string"},"status_error_code":{"type":"number"}}},"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":"\nYou can retreive data on expected future withdrawals of your sellers using this endpoint. \n\n#### Query pagination (more than 500 results)\n\nIf you are sending a query and expect to receive more than 500 results, make sure you use this function of Query Pagination. \n\n```json\n{\n  \"seller_payme_id\": \"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX\",\n  ...\n  \"page_size\": 100, // Max allowed page size is 500\n  \"page\": 1\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Our unique seller ID (MPL).\r\n"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."}},"required":["seller_payme_id"]},"example":{"seller_payme_id":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","currency":"ILS"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"items_count":{"type":"integer","description":"Number of withdrawals"},"items":{"type":"array","items":{"type":"object","properties":{"start_time":{"type":"integer","description":"Date of the previous withdrawal (epoch)"},"end_time":{"type":"integer","description":"Date of the end of the period of the withdrawal (epoch)"},"created_at":{"type":"string","description":"Timestamp of the withdrawal creation"},"withdrawable":{"type":"integer","description":"Indicates if the fund is withdrawable"},"source":{"type":"integer","description":"Source of the withdrawal"},"source_text":{"type":"string","description":"Source of the withdrawal"},"card_brand":{"type":"integer","description":"Card brand"},"card_brand_text":{"type":"string","description":"Card brand"},"total":{"type":"string","description":"Withdrawal total amount"},"withdrawal_payme_code":{"type":"string","description":"Withdrawal code"}}}},"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)"}}},"example":{"items_count":1,"items":[{"start_time":1687774500,"end_time":-1,"created_at":"2023-06-20 14:00:20","withdrawable":1,"source":1,"source_text":"פאיימי","card_brand":1,"card_brand_text":"אחר","total":"156390","withdrawal_payme_code":"withdrawal-code"}],"status_code":0}}}}}}},"/funds-transfer/aggregated":{"get":{"operationId":"get-funds-transfer-aggregated","summary":"Aggregated Wallets Data","tags":["Query APIs"],"description":"## Overview\n\nUsing this method, you can retreive data regarding your wallet or wallets for a certain day. \n\nYou'll be able to get the following information:\n\nValue | Description\n---|---\n`outgoing_amount` | The daily outgoing funds amount.\n`outgoing_count`| The daily outgoing transactions count.\n`ingoing_amount`| The daily ingoing funds amount.\n`ingoing_count`|The daily ingoing transactions count.\n`daily_withdrawal_amount`| The daily withdrawal amount.","parameters":[{"name":"start_date","in":"query","required":false,"description":"The start date of the query.","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"The end date of the query.","schema":{"type":"string"}},{"name":"seller_payme_id","in":"query","required":false,"description":"The specific MPL to be searched for.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer"},"page":{"type":"integer"},"items_total":{"type":"integer"},"items_per_page":{"type":"integer"},"start_date":{"type":"string"},"end_date":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"seller_payme_id":{"type":"string"},"currency":{"type":"string"},"date":{"type":"string"},"outgoing_transaction_count":{"type":"integer"},"outgoing_transaction_amount":{"type":"string"},"ingoing_transaction_count":{"type":"integer"},"ingoing_transaction_amount":{"type":"string"}}}}}},"example":{"status_code":0,"page":1,"items_total":1,"items_per_page":1,"start_date":"2022-05-18","end_date":"2022-05-18","items":[{"seller_payme_id":"MPL90008-90008EXM-EXAMPLE0-EXAMPLE9","currency":"ILS","date":"2022-05-18 23:30:10","outgoing_transaction_count":10,"outgoing_transaction_amount":"10002.12","ingoing_transaction_count":12,"ingoing_transaction_amount":"20000.12"}]}}}}}}},"/banks/{country_iso_code}":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-banks-country-iso-code","summary":"List of available banks","tags":["Query APIs"],"description":"## Overview\n\nThis API Endpoint will allow you retreive a list of available banks by filtering your request per country.","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Your PayMe's Partner Secret Key","schema":{"type":"string"}},{"name":"country_iso_code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`status_code` = 0 (success)\n`status_code` = 1 (failure)"},"items_count":{"type":"integer","description":"The total items count in your response"},"items_per_page":{"type":"integer","description":"The total items count per page in your response"},"country_code":{"type":"string","description":"Find the iso codes [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)"},"items":{"type":"array","description":"The items object - presenting the list of banks","items":{"type":"object","properties":{"code":{"type":"string","description":"Bank code"},"local_name":{"type":"string","description":"Local bank name"},"international_name":{"type":"string","description":"Internal bank name"}}}}}},"example":{"status_code":0,"items_count":0,"items_per_page":0,"country_code":"string","items":[{"code":"string","local_name":"string","international_name":"string"}]}}}}}}},"/funds-transfer":{"get":{"operationId":"get-funds-transfer","summary":"Wallet to Wallet transfers","tags":["Query APIs"],"description":"## Overview\n\nThis endpoint enable you to receive data of funds transfers between wallets in PayMe.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key."},"seller_payme_id_origin":{"type":"string","description":"The MPL of the seller that their wallet will be used to transfer the funds."},"seller_payme_id_destination":{"type":"string","description":"The MPL of the seller that their wallet will receive the funds."},"currency":{"type":"string","description":"Sale currency. 3-letter ISO 4217 name."},"start_date":{"type":"string","description":"The start date of the query."},"end_date":{"type":"string","description":"The end date of the query."}},"required":["payme_client_key"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id_origin":"MPL1DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","seller_payme_id_destination":"MPL2DEMO-XXXXXXXX-XXXXXXXX-XXXXXXXX","currency":"ILS","start_date":"2023-05-04","end_date":"2023-05-04"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)"},"page":{"type":"integer","description":"Page number"},"currency":{"type":"string","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217)."},"start_date":{"type":"string","description":"The start date of the query."},"end_date":{"type":"string","description":"The end date of the query."},"items_total":{"type":"integer","description":"Count of Wallet to Wallet transactions in the chosen period."},"items_per_page":{"type":"integer","description":"Count of Wallet to Wallet transactions in the page."},"items":{"type":"array","description":"Detailed Transactions."}}},"example":{"status_code":0,"page":1,"currency":"ILS","start_date":"2023-05-04","end_date":"2023-05-04","items_total":0,"items_per_page":0,"items":[]}}}}}}},"/credit-match":{"post":{"operationId":"post-credit-match","summary":"Withdrawal Correlation","tags":["Query APIs"],"description":"\nThis endpoint retrieves credit match information for a specific seller and withdrawal.\n\n\nRequest Body:\n```json\n{\n    \"seller_payme_id\": \"string\", //Your unique seller ID\n    \"withdrawal_payme_code\": number //The withdrawal number as received from POST get-withdrawals API endpoint\n}\n```\n\nParameters:\n- `seller_payme_id` (required): The unique identifier for the seller in the Payme system.\n- `withdrawal_payme_code` (required): The Payme code for the specific withdrawal.\n\nSuccessful Response (HTTP 200):\nThe response includes detailed information about the withdrawal, seller, and associated transactions.\n\nError Responses (HTTP 500):\n1. Seller not found:\n```json\n{\n    \"status_code\": 1,\n    \"status_error_details\": \"מוכר לא נמצא\",\n    \"status_additional_info\": \"seller_payme_id\",\n    \"status_error_code\": 251,\n    \"session\": \"string\"\n}\n```\n\n2. Withdrawal not found:\n```json\n{\n    \"status_code\": 1,\n    \"status_error_details\": \"משיכה לא נמצאה\",\n    \"status_additional_info\": number,\n    \"status_error_code\": 906,\n    \"session\": \"string\"\n}\n```\n\nNotes:\n- Ensure that the `seller_payme_id` and `withdrawal_payme_code` are valid before making the request.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"Your unique PayMe seller identifier."},"withdrawal_payme_code":{"type":"integer","description":"Your unique Withdrawal code."}},"required":["seller_payme_id","withdrawal_payme_code"]},"example":{"seller_payme_id":"MPL90006-90006EXM-EXAMPLE0-EXAMPLE9","withdrawal_payme_code":1066726}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The unique PayMe seller identifier."},"seller_id":{"type":"string","description":"The external Seller ID, provided by the integrator."},"withdrawal_payme_code":{"type":"integer","description":"The withdrawal unique code."},"withdrawal_created":{"type":"string","description":"The date the withdrawal was created in timestamp format."},"withdrawal_created_epoch":{"type":"integer","description":"The date the withdrawal was created in epoch format."},"withdrawal_total":{"type":"integer","description":"The withdrawal total in cents (agorot)."},"withdrawal_currency":{"type":"string","description":"The withdrawal currency, 3 letter ISO code."},"items_count":{"type":"integer","description":"The total count of items assembling the withdrawal. (Transactions and Charges)"},"items":{"type":"array","items":{"type":"object","properties":{"credit_vas_id":{"type":"string","description":"The VAS identifier that was used to create the charge.\n"},"sale_remote_id":{"type":"string","description":"The external sale identifier."},"tran_id":{"type":"integer","description":"The entity unique ID."},"tran_type":{"type":"string","description":"The entity type ID."},"tran_created":{"type":"string","description":"The date the entity was created on in timestamp format."},"tran_created_epoch":{"type":"string","description":"The date the entity was created in Epoch format."},"tran_total":{"type":"integer","description":"The entity total value, in cents (Agorot)"},"tran_total_after_deduction":{"type":"integer","description":"Total after deduction (will be equal to total by default)."},"tran_currency":{"type":"string","description":"The currency of the entity."},"tran_installments":{"type":"integer","description":"The installments count of the transaction."},"tran_description":{"type":"string","description":"The description of the entity."},"tran_remote_id":{"type":"string","description":"The remote ID given by the integrator."},"tran_voucher":{"type":"string","description":"The voucher of the transaction."},"sale_payme_code":{"type":"integer","description":"The unique PayMe sale identifer."},"sale_buyer_name":{"type":"string","description":"The buyer name of the transaction."}}}},"status_code":{"type":"integer","description":"Status code.\n`0` - Successful request.\n`1` - Failed request."},"session":{"type":"string","description":"The unique session "}}},"example":{"seller_payme_id":"MPL90006-90006EXM-EXAMPLE0-EXAMPLE9","seller_id":"il-110110738-1677599477","withdrawal_payme_code":1066726,"withdrawal_created":"2024-07-28 12:29:40","withdrawal_created_epoch":1722158980,"withdrawal_total":285511,"withdrawal_currency":"ILS","items_count":10,"items":[{"credit_vas_id":"VASL1677-599477XY-YKWVZACW-IWQ3BG6Y","sale_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_id":191208278,"tran_type":"102","tran_created":"2024-07-24 21:14:33","tran_created_epoch":"1721844873","tran_total":-140,"tran_total_after_deduction":-140,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Processing Charge","tran_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_voucher":"6003289","sale_payme_code":61974223,"sale_buyer_name":"ליאור צוק"},{"credit_vas_id":"VASL1677-599477HY-GUKISPF6-AHGOSEWS","sale_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_id":191208274,"tran_type":"102","tran_created":"2024-07-24 21:14:33","tran_created_epoch":"1721844873","tran_total":-1578,"tran_total_after_deduction":-1578,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Advancement services","tran_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_voucher":"6003289","sale_payme_code":61974223,"sale_buyer_name":"ליאור צוק"},{"credit_vas_id":"VASL1677-599477LB-MLQDCS8F-KTGONSZE","sale_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_id":191208270,"tran_type":"102","tran_created":"2024-07-24 21:14:33","tran_created_epoch":"1721844873","tran_total":-2953,"tran_total_after_deduction":-2953,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Processing Fee","tran_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_voucher":"6003289","sale_payme_code":61974223,"sale_buyer_name":"ליאור צוק"},{"credit_vas_id":null,"sale_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_id":224152597,"tran_type":"1","tran_created":"2024-07-24 21:14:33","tran_created_epoch":"1721844873","tran_total":155000,"tran_total_after_deduction":155000,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה ","tran_remote_id":"rVrUy44C75ZShMORPNGkz9MVK","tran_voucher":"6003289","sale_payme_code":61974223,"sale_buyer_name":"ליאור צוק"},{"credit_vas_id":"VASL1677-599477LB-MLQDCS8F-KTGONSZE","sale_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_id":191334587,"tran_type":"102","tran_created":"2024-07-25 21:15:20","tran_created_epoch":"1721931320","tran_total":-2667,"tran_total_after_deduction":-2667,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Processing Fee","tran_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_voucher":"7001937","sale_payme_code":62018574,"sale_buyer_name":"Ofri Katz"},{"credit_vas_id":null,"sale_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_id":224212542,"tran_type":"1","tran_created":"2024-07-25 21:15:20","tran_created_epoch":"1721931320","tran_total":140000,"tran_total_after_deduction":140000,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה ","tran_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_voucher":"7001937","sale_payme_code":62018574,"sale_buyer_name":"Ofri Katz"},{"credit_vas_id":"VASL1677-599477HY-GUKISPF6-AHGOSEWS","sale_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_id":191334591,"tran_type":"102","tran_created":"2024-07-25 21:15:21","tran_created_epoch":"1721931321","tran_total":-1425,"tran_total_after_deduction":-1425,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Advancement services","tran_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_voucher":"7001937","sale_payme_code":62018574,"sale_buyer_name":"Ofri Katz"},{"credit_vas_id":"VASL1677-599477XY-YKWVZACW-IWQ3BG6Y","sale_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_id":191334595,"tran_type":"102","tran_created":"2024-07-25 21:15:21","tran_created_epoch":"1721931321","tran_total":-140,"tran_total_after_deduction":-140,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה Processing Charge","tran_remote_id":"r36GeI5Crm2JORFnXANDmAHpm","tran_voucher":"7001937","sale_payme_code":62018574,"sale_buyer_name":"Ofri Katz"},{"credit_vas_id":"VASL1677-599477Q0-DC5MSVNQ-H7JBRQQZ","sale_remote_id":"rZsj2JQB3rVSfeLsVyPEAmH8H","tran_id":191290928,"tran_type":"102","tran_created":"2024-07-25 10:38:05","tran_created_epoch":"1721893085","tran_total":-293,"tran_total_after_deduction":-293,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה שירות 3DSecure","tran_remote_id":"rZsj2JQB3rVSfeLsVyPEAmH8H","tran_voucher":null,"sale_payme_code":62211761,"sale_buyer_name":""},{"credit_vas_id":"VASL1677-599477Q0-DC5MSVNQ-H7JBRQQZ","sale_remote_id":"rZsj2JQB3rVSfeLsVyPEAmH8H","tran_id":191291080,"tran_type":"102","tran_created":"2024-07-25 10:41:03","tran_created_epoch":"1721893263","tran_total":-293,"tran_total_after_deduction":-293,"tran_currency":"ILS","tran_installments":1,"tran_description":"עמוד תשלום - סטודיו דוצ׳ה שירות 3DSecure","tran_remote_id":"rZsj2JQB3rVSfeLsVyPEAmH8H","tran_voucher":null,"sale_payme_code":62211926,"sale_buyer_name":""}],"status_code":0,"session":"FIV3zo4M"}}}},"500":{"description":"Internal Server Error","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status code.\n`0` - Successful request.\n`1` - Failed request."},"status_error_details":{"type":"string","description":"Error description."},"status_additional_info":{"type":"integer","description":"Error additional information."},"status_error_code":{"type":"integer","description":"PayMe error code."},"session":{"type":"string","description":"PayMe session ID."}}},"example":{"status_code":1,"status_error_details":"משיכה לא נמצאה","status_additional_info":1066726222,"status_error_code":906,"session":"FhT3aXe7"}}}}}}},"/get-transaction-statistics":{"post":{"operationId":"post-get-transaction-statistics","summary":"Get Transaction Statistics","tags":["Get Transaction Statistics"],"description":"This endpoint enable to get transaction average, based on the chosen period (`time_resolution`), transaction's status (pending/validated) and currency.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"PayMe Partner Key."},"time_resolution":{"type":"string","description":"The selected period."},"start_date":{"type":"string","description":"The start date of the selected period."},"end_date":{"type":"string","description":"The start date of the selected period."},"transaction_status":{"type":"array","description":"Filter the status of the transactions that will take into account in the calculation. For all the transaction statuses see [Transaction Statuses](/marketplaces-and-platforms/lists-statuses/transaction-statuses).\n\nExample: pending"},"sale_currency":{"type":"array","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217).\n\nExample: ILS"}}},"example":{"payme_client_key":"XXXXXXXX","time_resolution":"day","start_date":"YYYY-MM-DD HH:MM:SS","end_date":"YYYY-MM-DD HH:MM:SS","transaction_status":["pending","validated"],"sale_currency":["ILS","USD"]}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)"},"start_date":{"type":"string","description":"The start date of the selected period."},"end_date":{"type":"string","description":"The end date of the selected period."},"time_resolution":{"type":"string","description":"The selected period."},"statistics":{"type":"object","properties":{"pending":{"type":"object","description":"Transaction statistics in the chosen status","properties":{"ILS":{"type":"array","description":"Transaction statistics in the chosen currency","items":{"type":"object","properties":{"sum":{"type":"integer"},"count":{"type":"integer"},"average":{"type":"integer"}}}}}}}}}},"example":{"status_code":0,"start_date":"YYYY-MM-DD HH:MM:SS","end_date":"YYYY-MM-DD HH:MM:SS","time_resolution":"day","statistics":{"pending":{"ILS":[{"sum":0,"count":0,"average":0},{"sum":0,"count":0,"average":0}]}}}}}}}}},"/get-transaction-data":{"post":{"security":[{"publicKey":[]}],"operationId":"post-get-transaction-data","summary":"Get Transaction Data","tags":["Get Transaction Data"],"description":"## Overview\n\nThis endpoint enable to get transaction, based on the transaction status, sale status, sale currency and sale payment method.","parameters":[{"name":"PayMe-Public-Key","in":"header","required":false,"description":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"transaction_type":{"type":"integer","description":"Filter the type of the transactions that will be presented. For all the transaction types see [Transaction Types](/marketplaces-and-platforms/lists-statuses/transaction-types)."},"transaction_status":{"type":"string","description":"Filter the status of the transactions that will be presented. For all the transaction statuses see [Transaction Statuses](/marketplaces-and-platforms/lists-statuses/transaction-statuses)."},"sale_status":{"type":"array","description":"Filter the status of the sales that will be presented. For all the sale statuses see [Sale Statuses](/marketplaces-and-platforms/lists-statuses/sale-statuses).\n\nExample: \"initial\""},"sale_currency":{"type":"array","description":"Sale currency. [3-letter ISO 4217 name](https://en.wikipedia.org/wiki/ISO_4217).\n\nExample: \"ILS\""},"sale_payment_method":{"type":"array","description":"the Payment method used to pay the sale.\n\nFor all the payment methods see [Available Payment Methods](/payments/direct-api/available-payment-methods).\n\nExample: \"credit-card\""}}},"example":{"transaction_type":1,"transaction_status":"validated","sale_status":["completed"],"sale_currency":["ILS"],"sale_payment_method":["credit-card"]}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"Status of the request (0 - success, 1 - error)"},"items":{"type":"array","description":"The transactions details."},"items_count":{"type":"integer","description":"Count of the transactions."}}},"example":{"status_code":0,"items":[],"items_count":0}}}}}}}},"tags":[{"name":"Hosted Payment Page"},{"name":"Direct API"},{"name":"Point of Sale (POS)"},{"name":"Post Sale Actions"},{"name":"Subscriptions"},{"name":"Tokenization"},{"name":"Merchants Management"},{"name":"Buyers Management"},{"name":"Standalone 3D Secure service"},{"name":"Invoices"},{"name":"Query APIs"},{"name":"Get Transaction Statistics"},{"name":"Get Transaction Data"}],"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"}}}}