{"openapi":"3.1.0","info":{"title":"Payments","version":"1.0.0","description":"API reference for accepting payments with PayMe — sales via hosted payment page, hosted fields or direct API, tokens, subscriptions, refunds and captures, 3D Secure, invoices and point-of-sale. Start with Getting Started for credentials, environments and a first sale."},"servers":[{"url":"https://sandbox.payme.io/api","description":"Sandbox"},{"url":"https://live.payme.io/api","description":"Production"}],"components":{"securitySchemes":{"merchantKey":{"type":"apiKey","in":"header","name":"PayMe-Merchant-Key"},"partnerKey":{"type":"apiKey","in":"header","name":"PayMe-Partner-Key"},"publicKey":{"type":"apiKey","in":"header","name":"PayMe-Public-Key"},"signature":{"type":"apiKey","in":"header","name":"PayMe-Signature"}}},"tags":[{"name":"Merchants Management"}],"paths":{"/create-seller":{"post":{"operationId":"post-create-seller","summary":"Create a seller","tags":["Merchants Management"],"description":"Creates a seller under your partner account and returns its `seller_payme_id` (MPL), its public key, and a link where the seller finishes onboarding. Partners only: send your `payme_client_key`. A seller's MPL can't be used to create sellers. For the whole onboarding flow, see [Create sellers](/marketplaces-and-platforms/seller-onboarding/create-seller).\n\nPayMe sets which fields are required for your account. A missing required field returns error `19`, with the field name in `status_additional_info`. The **Required** column below shows the usual setup. `seller_email` is always required and must be unique among your sellers (error `150`). `seller_id`, if you send it, must also be unique among your sellers (error `108`). Other fields can be enabled for your account by PayMe.\n\nThe call is limited to 5 requests per minute per IP. Over the limit, or while a call for the same `seller_email` is still running, you get HTTP 429 with error `998`. Wait and retry.\n\n### Testing in the sandbox\n\nField | Test value\n---|---\n`seller_social_id` | `9999999999`. PayMe replaces it with a random valid ID.\n`seller_email` | `random@paymeservice.com`. PayMe replaces it with a unique address and sends no emails.\n`seller_bank_code` | `54`\n`seller_bank_branch` | Any 3 digits, for example `123`\n`seller_bank_account_number` | Any 6 digits, for example `123456`\n\n### Callback\n\nWhen the seller is created or updated, PayMe sends a seller callback (`POST`, `x-www-form-urlencoded`) to your default callback URL. The fields are listed on [Callbacks → Sellers](/payments/getting-started/callbacks#sellers-partners).\n\n### Errors\n\nEvery error returns `status_code` `1` with the code in `status_error_code`. The common ones:\n\nCode | Meaning\n---|---\n`1` | A required parameter is missing, for example `payme_client_key`.\n`5` | `seller_description` is longer than 255 characters.\n`13` | `seller_email` is missing or invalid.\n`19` | A field your account requires is missing. `status_additional_info` names it.\n`25` | Invalid phone number.\n`57` | `seller_merchant_name_en` or `seller_dba_en` isn't in Latin characters.\n`101` | Invalid national ID number.\n`106` | Unknown `seller_bank_code`.\n`108` | `seller_id` is already used by another of your sellers.\n`110` | Unknown or inactive business field in `seller_person_business_type`.\n`114` | Unknown incorporation type, a type from another country than `seller_address_country`, or a `seller_inc_code` that doesn't fit the type.\n`116` / `117` / `118` | Invalid birth date / registration date / ID issue date.\n`119` | Invalid `seller_retail_type`.\n`120` | Invalid characters in `seller_merchant_name`.\n`121` | `seller_inc_code` isn't a number.\n`131` | Invalid `seller_gender`.\n`150` | `seller_email` is already used by another of your sellers.\n`160` | An item in `seller_additional_details` has no `type`, or one of its files isn't an individual file type.\n`165` | Invalid bank branch or account number.\n`304` | `market_fee` is outside 0–60.\n`912` | Unknown `seller_address_country`.\n`998` | HTTP 429: over the rate limit, or a call for the same `seller_email` is still running.\n\nThe full list is on [Errors](/payments/getting-started/errors).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key. Partners only."},"seller_id":{"type":"string","description":"Your own ID for the seller. Must be unique among your sellers (error `108`)."},"seller_first_name":{"type":"string","description":"First name of the seller's owner (the seller's primary individual)."},"seller_last_name":{"type":"string","description":"Last name of the seller's owner."},"seller_social_id":{"type":"string","description":"National ID number of the seller's owner. An invalid number returns error `101`. In the sandbox, `9999999999` is replaced with a random valid ID."},"seller_birthdate":{"type":"string","description":"Seller's personal birth date. Required by default; PayMe can change this per partner. Format `dd/mm/yyyy` with leading zeros only: `06/05/1989` is accepted, `6/5/1989` and `06-05-1989` are rejected. The person must be at least 16. Responses return `yyyy-mm-dd`.       "},"seller_social_id_issued":{"type":"string","description":"Seller's personal social ID issuing day. Required by default; PayMe can change this per partner. Format `dd/mm/yyyy` with leading zeros only. Responses return `yyyy-mm-dd`.      "},"seller_gender":{"type":"integer","description":"`0` – male, `1` – female, `2` – other. Another value returns error `131`."},"seller_email":{"type":"string","description":"The seller's email address. Always required. It must be unique among your sellers (error `150`), and an invalid address returns error `13`. In the sandbox, `random@paymeservice.com` is replaced with a unique address."},"seller_phone":{"type":"string","description":"Seller phone number, supplied as a string. Mobile and landline formats are supported; international format with country code is recommended. Local numbers are interpreted using the seller's country, Israel by default. Phone validation or normalization failures return error `25`."},"seller_contact_email":{"type":"string","description":"Seller's contact email, shown to buyers. If not sent, it is copied from `seller_email`. "},"seller_contact_phone":{"type":"string","description":"Phone number shown to buyers. If you don't send it, it is copied from `seller_phone`."},"seller_bank_code":{"type":"integer","description":"Bank code. See [Banks in Israel](/payments/codes-statuses/banks-in-israel). An unknown code returns error `106`."},"seller_bank_branch":{"type":"integer","description":"Bank branch number, up to 3 digits. An invalid branch returns error `165`."},"seller_bank_account_number":{"type":"string","description":"Bank account number, digits only. An invalid number returns error `165`."},"seller_description":{"type":"string","description":"Seller’s description, including offered product line and services. Limited to 255 characters (error `5`).  "},"seller_site_url":{"type":"string","description":"The seller's website URL."},"seller_person_business_type":{"type":"integer","description":"Business field code (the seller's line of business). See [Business field codes](/marketplaces-and-platforms/seller-reference/mcc-list), or get the live list from [List business fields](/payments/merchants-management/get-business-fields). An unknown or inactive code returns error `110`."},"seller_inc":{"type":"integer","description":"Incorporation type, see [Seller incorporation types](/marketplaces-and-platforms/seller-reference/seller-incorporation-types-il). Required by default; PayMe can change this per partner. The type must belong to the seller's country (`seller_address_country`, default Israel), otherwise error `114`. If you send `seller_inc` without `seller_person_business_type`, the business field defaults to `205`.  "},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ). May be required for your account (PayMe configures this per partner). When sent, it must be a number, 0 or above, otherwise the request fails with error `121`. For Israeli sellers, Individual, Sole Proprietorship and Exempt Sole Proprietorship must use the owner's national ID; other types must not equal the national ID and must start with that type's 2-digit company-registry prefix. Otherwise the request fails with error `114`.     "},"seller_registration_date":{"type":"string","description":"Seller's business registration date. May be required for your account (PayMe configures this per partner). Format `dd/mm/yyyy` with leading zeros only: `01/02/2020` is accepted, `1/2/2020` and `01-02-2020` are rejected. Responses return `yyyy-mm-dd`.     "},"seller_retail_type":{"type":"integer","description":"`1` – card not present (online), `2` – card present, `4` – MOTO (phone or mail order). Another value returns error `119`."},"seller_merchant_name":{"type":"string","description":"The business's name. Invalid characters return error `120`. May be required for your account (PayMe configures this per partner).  "},"seller_merchant_name_en":{"type":"string","description":"The business's name in English. Latin characters only (error `57`)."},"seller_dba":{"type":"string","description":"The seller's legal (registered) name in Hebrew."},"seller_dba_en":{"type":"string","description":"The seller's legal (registered) name in English. Latin characters only (error `57`)."},"seller_address_city":{"type":"string","description":"Business address: city."},"seller_address_street":{"type":"string","description":"Business address: street."},"seller_address_street_number":{"type":"string","description":"Business address: street number."},"seller_address_country":{"type":"string","description":"Business address: country, as an ISO 3166-1 alpha-2 code such as `IL`. Default Israel. An unknown code returns error `912`. "},"seller_first_name_en":{"type":"string","description":"The seller's first name in English."},"seller_last_name_en":{"type":"string","description":"The seller's last name in English."},"seller_address_state":{"type":"string","description":"State or region of the business address, for sellers outside Israel."},"seller_address_zip":{"type":"string","description":"Postal code of the business address."},"seller_file_social_id":{"type":"string","description":"Public URL of the owner's ID card (file type `1`). PayMe downloads it in the background. To upload other documents, use [Upload seller files](/payments/merchants-management/post-upload-seller-files)."},"seller_file_cheque":{"type":"string","description":"Public URL of a bank account confirmation or a cancelled cheque (file type `2`). PayMe downloads it in the background."},"seller_file_corporate":{"type":"string","description":"Public URL of the incorporation certificate (file type `3`). PayMe downloads it in the background."},"market_fee":{"type":"number","description":"The seller's default platform fee: the percent of the sale price collected for you, from `0` to `60` (for example `2.5`). It includes VAT and is added on top of PayMe's fees. Default `0`. Out of range returns error `304`. A sale can override it with its own `market_fee`. It can't be changed later with Update a seller; see [Platform fees](/marketplaces-and-platforms/fees-and-payouts/platform-fees)."},"seller_plan":{"type":"string","description":"A predefined set of settings for the seller. If required, this value will be provided by your Account Manager. Required unless your account has a default plan.  "},"seller_additional_details":{"type":"array","description":"More people in the business, such as owners, signatories and directors. One object per person.","items":{"type":"object","properties":{"first_name":{"type":"string","description":"First name."},"last_name":{"type":"string","description":"Last name."},"national_id":{"type":"string","description":"National ID number."},"social_id_issued":{"type":"string","description":"ID issue date, `dd/mm/yyyy`."},"date_of_birth":{"type":"string","description":"Date of birth, `dd/mm/yyyy`."},"email":{"type":"string","description":"Email address."},"phone":{"type":"string","description":"Phone number."},"type":{"type":"array","description":"The person's roles, as an array of [individual role](/marketplaces-and-platforms/seller-reference/individual-seller-types) codes, for example `[1, 2]` for an owner who is also a signatory. Missing returns error `160`."},"business_title":{"type":"string","description":"Job title in the business."},"ownership_percent":{"type":"number","description":"Ownership share, percent."},"address_country":{"type":"string","description":"Address: country."},"address_state":{"type":"string","description":"Address: state or region."},"address_city":{"type":"string","description":"Address: city."},"address_street":{"type":"string","description":"Address: street."},"address_building_number":{"type":"string","description":"Address: building number."},"address_zip":{"type":"string","description":"Address: postal code."},"files":{"type":"array","description":"The person's documents. Only individual file types `90`–`97` are accepted (see [File types](/marketplaces-and-platforms/seller-reference/file-types)); another type returns error `160`.","items":{"type":"object","properties":{"type":{"type":"integer","description":"File type code, `90`–`97`. See [File types](/marketplaces-and-platforms/seller-reference/file-types)."},"url":{"type":"string","description":"Public URL of the file. Send `url` or `base64`."},"base64":{"type":"string","description":"The file content, base64-encoded. Send `url` or `base64`."},"name":{"type":"string","description":"File name with extension, for example `id-front.jpg`."},"mime_type":{"type":"string","description":"MIME type of the file, for example `image/jpeg` or `application/pdf`."}},"required":["type"]}}},"required":["type"]}},"language":{"type":"string","description":"Language of error messages: `he` (default) or `en`."}},"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_site_url","seller_person_business_type","seller_inc","seller_address_city","seller_address_street","seller_address_street_number"]},"example":{"payme_client_key":"XXXXXXXX","seller_id":"store-1001","seller_first_name":"Dana","seller_last_name":"Levi","seller_social_id":"9999999999","seller_birthdate":"06/05/1989","seller_social_id_issued":"01/02/2015","seller_gender":1,"seller_email":"random@paymeservice.com","seller_phone":"+972501234567","seller_bank_code":54,"seller_bank_branch":123,"seller_bank_account_number":"123456","seller_description":"Handmade ceramics","seller_site_url":"https://www.example.com","seller_person_business_type":205,"seller_inc":1,"seller_merchant_name":"Dana Ceramics","seller_address_city":"Tel Aviv","seller_address_street":"Herzl","seller_address_street_number":"10","seller_address_country":"IL","market_fee":2.5,"language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"seller_payme_id":{"type":"string","description":"The new seller's MPL. Use it on every call for this seller and keep it on your server."},"seller_payme_secret":{"type":"string","description":"Not a credential: a random value that PayMe does not store or check. Ignore it (see [Authentication](/payments/getting-started/authentication))."},"seller_public_key":{"type":"object","description":"The seller's public key, for browser code such as Hosted Fields.","properties":{"uuid":{"type":"string","description":"The public key."},"description":{"type":"string","description":"Name of the key."},"is_active":{"type":"boolean","description":"`true` when the key is active."}}},"seller_id":{"type":"string","description":"Your own ID for the seller, as you sent it."},"seller_dashboard_signup_link":{"type":"string","description":"Link where the seller sets a password and finishes onboarding. Send it to the seller. Its host depends on your partner account and may differ from the API host, so use it as returned and don't build it yourself."}}},"example":{"status_code":0,"session":"a1B2c3D4","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_payme_secret":"Qw3rTy7uI9oP1aS5dF8gH2jK4lZ6xC","seller_public_key":{"uuid":"12345678-1234-4abc-9def-123456789012","description":"PayMe-Public-Key","is_active":true},"seller_id":"store-1001","seller_dashboard_signup_link":"https://<signup-host>/<link-from-payme>"}}}},"429":{"description":"Too many requests (error `998`)","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Operation is not permitted","status_additional_info":"Too Many Attempts.","status_error_code":998,"session":"a1B2c3D4"}}}},"500":{"description":"Error, for example error `150`: the email address is already used by another of your sellers","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Email is already in use","status_additional_info":null,"status_error_code":150,"session":"a1B2c3D4"}}}}}}},"/update-seller":{"post":{"operationId":"post-update-seller","summary":"Update a seller","tags":["Merchants Management"],"description":"Changes the details of one of your sellers. Partners only: send your `payme_client_key`, the seller's `seller_payme_id` (or your own `seller_id` for the seller), and only the fields you want to change. Every other field is optional.\n\nPayMe sets, per partner, which fields can still be changed once they have a value. Changing a locked field that already has a value returns error `33`. A request with no updatable field returns error `19`. The response returns the seller's details after the update.\n\nThe seller's default `market_fee` can't be changed with this call. To change it, contact PayMe Partners (partners@payme.io). The per-sale `market_fee` on generate-sale is not affected.\n\n`seller_additional_details` adds people to the seller. It doesn't change or remove the people already on file.\n\nIn the sandbox, the test values listed on [Create a seller](/payments/merchants-management/post-create-seller) work here too.\n\n### Callback\n\nAfter the update, PayMe sends a seller callback (`POST`, `x-www-form-urlencoded`) to your default callback URL. The fields are listed on [Callbacks → Sellers](/payments/getting-started/callbacks#sellers-partners).\n\n### Errors\n\nEvery error returns `status_code` `1` with the code in `status_error_code`. Besides the field validation errors listed on [Create a seller](/payments/merchants-management/post-create-seller):\n\nCode | Meaning\n---|---\n`1` | A required parameter is missing.\n`19` | No updatable field was sent.\n`33` | A locked field that already has a value was changed.\n`251` | No seller has this `seller_payme_id`.\n`163` | The seller is inactive.\n`20` | The seller belongs to another partner.\n\nThe full list is on [Errors](/payments/getting-started/errors).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key."},"seller_payme_id":{"type":"string","description":"The seller's MPL. Required unless you send `seller_id`."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent on Create a seller. Use it with `payme_client_key` instead of `seller_payme_id` to identify the seller. It can't be changed."},"seller_first_name":{"type":"string","description":"First name of the seller's owner."},"seller_last_name":{"type":"string","description":"Last name of the seller's owner."},"seller_social_id":{"type":"string","description":"National ID number of the seller's owner. An invalid number returns error `101`."},"seller_birthdate":{"type":"string","description":"Seller's personal birth date. Format `dd/mm/yyyy` with leading zeros only: `06/05/1989` is accepted, `6/5/1989` and `06-05-1989` are rejected. The person must be at least 16. Responses return `yyyy-mm-dd`.      "},"seller_social_id_issued":{"type":"string","description":"Seller's personal social ID issuing day. Format `dd/mm/yyyy` with leading zeros only. Responses return `yyyy-mm-dd`.     "},"seller_gender":{"type":"integer","description":"`0` – male, `1` – female, `2` – other. Another value returns error `131`."},"seller_email":{"type":"string","description":"The seller's email address. It must be unique among your sellers (error `150`)."},"seller_phone":{"type":"string","description":"Seller's phone number.   "},"seller_contact_email":{"type":"string","description":"Seller's contact email, shown to buyers. If the seller has no contact email, it is copied from `seller_email`. "},"seller_contact_phone":{"type":"string","description":"Phone number shown to buyers."},"seller_bank_code":{"type":"integer","description":"Bank code. See [Banks in Israel](/payments/codes-statuses/banks-in-israel). An unknown code returns error `106`."},"seller_bank_branch":{"type":"integer","description":"Bank branch number, up to 3 digits. An invalid branch returns error `165`."},"seller_bank_account_number":{"type":"string","description":"Bank account number, digits only. An invalid number returns error `165`."},"seller_description":{"type":"string","description":"Seller’s description, including offered product line and services. Limited to 255 characters (error `5`).   "},"seller_site_url":{"type":"string","description":"The seller's website URL."},"seller_person_business_type":{"type":"integer","description":"Business field code (the seller's line of business). See [Business field codes](/marketplaces-and-platforms/seller-reference/mcc-list). An unknown or inactive code returns error `110`."},"seller_inc":{"type":"integer","description":"Incorporation type, see [Seller incorporation types](/marketplaces-and-platforms/seller-reference/seller-incorporation-types-il). The type must belong to the seller's country (`seller_address_country`, default Israel), otherwise error `114`.  "},"seller_inc_code":{"type":"string","description":"Seller's business ID (ח.פ, ע.מ). When sent, it must be a number, 0 or above, otherwise the request fails with error `121`. For Israeli sellers, Individual, Sole Proprietorship and Exempt Sole Proprietorship must use the owner's national ID; other types must not equal the national ID and must start with that type's 2-digit company-registry prefix. Otherwise the request fails with error `114`.     "},"seller_registration_date":{"type":"string","description":"Seller's business registration date. Format `dd/mm/yyyy` with leading zeros only: `01/02/2020` is accepted, `1/2/2020` and `01-02-2020` are rejected. Responses return `yyyy-mm-dd`.     "},"seller_retail_type":{"type":"integer","description":"`1` – card not present (online), `2` – card present, `4` – MOTO (phone or mail order). Another value returns error `119`."},"seller_merchant_name":{"type":"string","description":"The business's name. Invalid characters return error `120`.  "},"seller_merchant_name_en":{"type":"string","description":"The business's name in English. Latin characters only (error `57`)."},"seller_dba":{"type":"string","description":"The seller's legal (registered) name in Hebrew."},"seller_dba_en":{"type":"string","description":"The seller's legal (registered) name in English. Latin characters only (error `57`)."},"seller_address_city":{"type":"string","description":"Business address: city."},"seller_address_street":{"type":"string","description":"Business address: street."},"seller_address_street_number":{"type":"string","description":"Business address: street number."},"seller_address_country":{"type":"string","description":"Business address: country, as an ISO 3166-1 alpha-2 code such as `IL`. An unknown code returns error `912`."},"seller_first_name_en":{"type":"string","description":"The seller's first name in English."},"seller_last_name_en":{"type":"string","description":"The seller's last name in English."},"seller_address_state":{"type":"string","description":"State or region of the business address, for sellers outside Israel."},"seller_address_zip":{"type":"string","description":"Postal code of the business address."},"seller_file_social_id":{"type":"string","description":"Public URL of the owner's ID card (file type `1`). PayMe downloads it in the background. To upload other documents, use [Upload seller files](/payments/merchants-management/post-upload-seller-files)."},"seller_file_cheque":{"type":"string","description":"Public URL of a bank account confirmation or a cancelled cheque (file type `2`). PayMe downloads it in the background."},"seller_file_corporate":{"type":"string","description":"Public URL of the incorporation certificate (file type `3`). PayMe downloads it in the background."},"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_additional_details":{"type":"array","description":"Adds people to the seller, one object per person. People already on file are not changed. Each item has the same fields as on [Create a seller](/payments/merchants-management/post-create-seller).","items":{"type":"object","properties":{"first_name":{"type":"string","description":"First name."},"last_name":{"type":"string","description":"Last name."},"national_id":{"type":"string","description":"National ID number."},"social_id_issued":{"type":"string","description":"ID issue date, `dd/mm/yyyy`."},"date_of_birth":{"type":"string","description":"Date of birth, `dd/mm/yyyy`."},"email":{"type":"string","description":"Email address."},"phone":{"type":"string","description":"Phone number."},"type":{"type":"array","description":"The person's roles, as an array of [individual role](/marketplaces-and-platforms/seller-reference/individual-seller-types) codes, for example `[1, 2]` for an owner who is also a signatory. Missing returns error `160`."},"business_title":{"type":"string","description":"Job title in the business."},"ownership_percent":{"type":"number","description":"Ownership share, percent."},"address_country":{"type":"string","description":"Address: country."},"address_state":{"type":"string","description":"Address: state or region."},"address_city":{"type":"string","description":"Address: city."},"address_street":{"type":"string","description":"Address: street."},"address_building_number":{"type":"string","description":"Address: building number."},"address_zip":{"type":"string","description":"Address: postal code."},"files":{"type":"array","description":"The person's documents. Only individual file types `90`–`97` are accepted (see [File types](/marketplaces-and-platforms/seller-reference/file-types)); another type returns error `160`.","items":{"type":"object","properties":{"type":{"type":"integer","description":"File type code, `90`–`97`. See [File types](/marketplaces-and-platforms/seller-reference/file-types)."},"url":{"type":"string","description":"Public URL of the file. Send `url` or `base64`."},"base64":{"type":"string","description":"The file content, base64-encoded. Send `url` or `base64`."},"name":{"type":"string","description":"File name with extension, for example `id-front.jpg`."},"mime_type":{"type":"string","description":"MIME type of the file, for example `image/jpeg` or `application/pdf`."}},"required":["type"]}}},"required":["type"]}},"language":{"type":"string","description":"Language of error messages: `he` (default) or `en`."}},"required":["payme_client_key"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_site_url":"https://www.example.com","seller_contact_phone":"+972501234567","language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"seller_id":{"type":"string","description":"Your own ID for the seller, or `null`."},"seller_created":{"type":"string","description":"When the seller was created, `yyyy-mm-dd hh:mm:ss`."},"seller_active":{"type":"boolean","description":"`true` when the seller is active."},"seller_approved":{"type":"boolean","description":"`true` when PayMe has approved the seller. Payouts need approval."},"seller_is_deferred":{"type":"boolean","description":"`true` when the seller has a deferred account."},"seller_approved_date":{"type":"string","description":"When PayMe approved the seller, or `null`."},"seller_withdrawal_plan":{"type":"integer","description":"`1` – manual, `2` – daily, `3` – monthly."},"seller_withdrawal_date":{"type":"integer","description":"Day of the month of the payout when `seller_withdrawal_plan` is `3`, otherwise `null`."},"seller_allow_foreign_cards":{"type":"boolean","description":"`true` when the seller accepts foreign cards."},"seller_personal_details":{"type":"object","description":"The seller's owner (primary individual).","properties":{"seller_first_name":{"type":"string","description":"First name."},"seller_last_name":{"type":"string","description":"Last name."},"seller_social_id":{"type":"string","description":"National ID number."},"seller_social_id_issued":{"type":"string","description":"ID issue date, `yyyy-mm-dd`."},"seller_birthdate":{"type":"string","description":"Date of birth, `yyyy-mm-dd`."},"seller_date_of_birth":{"type":"string","description":"Legacy copy of `seller_birthdate`."},"seller_gender":{"type":"integer","description":"`0` – male, `1` – female, `2` – other."},"seller_email":{"type":"string","description":"The seller's email address."},"seller_phone":{"type":"string","description":"The seller's phone number."},"seller_first_name_en":{"type":"string","description":"First name in English."},"seller_last_name_en":{"type":"string","description":"Last name in English."},"seller_social_id_country":{"type":"string","description":"Country that issued the ID, ISO 3166-1 alpha-2."},"seller_has_criminal_record":{"type":"boolean","description":"As declared during onboarding, or `null`."}}},"seller_business_details":{"type":"object","description":"The business.","properties":{"seller_inc":{"type":"integer","description":"Incorporation type. `0` for a private individual."},"seller_inc_code":{"type":"string","description":"Business registration number."},"seller_registration_date":{"type":"string","description":"Business registration date, `yyyy-mm-dd`."},"seller_merchant_name":{"type":"string","description":"The business's name."},"seller_merchant_name_en":{"type":"string","description":"The business's name in English."},"seller_dba":{"type":"string","description":"Legal (registered) name in Hebrew."},"seller_dba_en":{"type":"string","description":"Legal (registered) name in English."},"seller_business_type":{"type":"integer","description":"Business field code, as sent in `seller_person_business_type`."},"seller_site_url":{"type":"string","description":"Website URL."},"seller_description":{"type":"string","description":"Description of the business."},"seller_retail_type":{"type":"integer","description":"`1` – card not present, `2` – card present, `4` – MOTO."},"seller_contact_email":{"type":"string","description":"Contact email shown to buyers."},"seller_contact_phone":{"type":"string","description":"Contact phone shown to buyers."},"seller_bank_account_code":{"type":"integer","description":"Bank code (sent as `seller_bank_code`)."},"seller_bank_account_branch":{"type":"integer","description":"Bank branch (sent as `seller_bank_branch`)."},"seller_bank_account_number":{"type":"string","description":"Bank account number."},"seller_need_foreign_currency":{"type":"boolean","description":"Whether the seller asked to work in foreign currencies, or `null`."},"seller_was_rejected_by_bank":{"type":"boolean","description":"Whether a bank rejected the seller before, as declared, or `null`."},"seller_bank_rejection_reason":{"type":"string","description":"The declared reason for the bank rejection, or `null`."},"seller_source_of_finance":{"type":"string","description":"Declared source of finance, as an enum name, or `null`."},"seller_required_service_type":{"type":"string","description":"Declared required service type, as an enum name, or `null`."},"seller_account_type":{"type":"string","description":"Account type, as an enum name."}}},"seller_address":{"type":"object","description":"The business address.","properties":{"seller_address_city":{"type":"string","description":"City."},"seller_address_street":{"type":"string","description":"Street."},"seller_address_street_number":{"type":"string","description":"Street number."},"seller_address_country":{"type":"string","description":"Country, ISO 3166-1 alpha-2."}}},"seller_processing_percent":{"type":"number","description":"How much of the seller's processing limit is used, percent."},"seller_processing_limit":{"type":"number","description":"The seller's processing limit."},"seller_timezone":{"type":"string","description":"The seller's time zone, for example `Asia/Jerusalem`."},"seller_display_language":{"type":"string","description":"The seller's language, for example `he` or `en`."}}},"example":{"status_code":0,"session":"a1B2c3D4","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_id":"store-1001","seller_created":"2026-01-15 10:30:00","seller_active":true,"seller_approved":true,"seller_withdrawal_plan":1,"seller_withdrawal_date":null,"seller_personal_details":{"seller_first_name":"Dana","seller_last_name":"Levi","seller_gender":1,"seller_email":"dana@example.com"},"seller_business_details":{"seller_inc":0,"seller_merchant_name":"Dana Ceramics","seller_site_url":"https://www.example.com","seller_contact_phone":"+972501234567"},"seller_address":{"seller_address_city":"Tel Aviv","seller_address_country":"IL"},"seller_display_language":"he"}}}},"500":{"description":"Error, for example error `33`: a locked field already has a value","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Cannot update as field is already set","status_additional_info":"seller_bank_account_number","status_error_code":33,"session":"a1B2c3D4"}}}}}}},"/upload-seller-files":{"post":{"operationId":"post-upload-seller-files","summary":"Upload seller files","tags":["Merchants Management"],"description":"Uploads KYC documents for one of your sellers, such as an ID card or a bank account confirmation. Partners only: send your `payme_client_key` and the seller's `seller_payme_id` (or your own `seller_id` for the seller). Send one file or several in `seller_files`. Each file is either a public `url` that PayMe downloads, or the file content in `base64`.\n\nSet each file's `type` from [File types](/marketplaces-and-platforms/seller-reference/file-types). Types `90`–`97` are personal documents. They are attached to the seller's primary individual, and the call fails with error `184` if the seller has more than one individual. All other types are attached to the seller.\n\nAllowed extensions: `pdf`, `jpg`, `jpeg`, `jfif`, `png`, `bmp`, `tif`, `tiff`, `doc`, `docx`, and `mp4`, `avi`, `mov`, `webm` for video (used for the face-to-face video, type `97`). Allowed MIME types include `application/pdf`, `image/jpeg`, `image/png`, `image/heic`, `image/tiff`, `application/msword`, `video/mp4` and `video/quicktime`.\n\n### Errors\n\nEvery error returns `status_code` `1` with the code in `status_error_code`.\n\nCode | When\n---|---\n`1` | `seller_files` is missing or empty (HTTP 400), or a file has neither `url` nor `base64`.\n`20` | A file's `type` is missing or not an integer (HTTP 400), or isn't a known file type.\n`184` | A personal document (types `90`–`97`) was sent for a seller with more than one individual.\n`904` | The file extension isn't allowed.\n`905` | The `mime_type` isn't allowed.\n`909` | PayMe can't read the file.\n\nThe full list is on [Errors](/payments/getting-started/errors).\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key."},"seller_payme_id":{"type":"string","description":"The seller's MPL. Required unless you send `seller_id`."},"seller_id":{"type":"string","description":"Your own ID for the seller, as sent on Create a seller. Use it instead of `seller_payme_id`."},"seller_files":{"type":"array","description":"The files to upload, at least one.","items":{"type":"object","properties":{"type":{"type":"integer","description":"Document type code, see [File types](/marketplaces-and-platforms/seller-reference/file-types). Missing or not an integer returns error `20`."},"url":{"type":"string","description":"Public URL of the file. Send `url` or `base64`."},"base64":{"type":"string","description":"The file content, base64-encoded. A `data:<mime>;base64,` prefix is allowed and sets the MIME type. Send `url` or `base64`."},"name":{"type":"string","description":"File name with extension, for example `id.pdf`. If you omit it, PayMe names the file from its MIME type."},"mime_type":{"type":"string","description":"MIME type of the file, for example `application/pdf` or `image/jpeg`."}},"required":["type"]}},"language":{"type":"string","description":"Language of error messages: `he` (default) or `en`."}},"required":["payme_client_key","seller_files"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","seller_files":[{"name":"social_id.pdf","type":1,"url":"https://www.example.com/files/social_id.pdf","mime_type":"application/pdf"},{"name":"cheque.png","type":2,"base64":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==","mime_type":"image/png"}],"language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` when the files were accepted."},"session":{"type":"string","description":"PayMe session ID."}}},"example":{"status_code":0,"session":"a1B2c3D4"}}}},"400":{"description":"Bad request, for example error `20`: a file's `type` is missing or invalid","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Validation error","status_additional_info":"type","status_error_code":20,"session":"a1B2c3D4"}}}},"500":{"description":"Error, for example error `904`: the file extension isn't allowed","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Invalid file extension","status_additional_info":null,"status_error_code":904,"session":"a1B2c3D4"}}}}}}},"/get-vas-seller":{"post":{"operationId":"post-get-vas-seller","summary":"List a seller's services","tags":["Merchants Management"],"description":"Returns the value-added services (VAS) installed on one of your sellers, with each service's prices, payer and status. Partners only: send your `payme_client_key` and the seller's `seller_payme_id`. Inactive sellers can be queried too.\n\nTo narrow the list, filter by `vas_type`, `vas_api_key` or `vas_payme_id`. Service types are on [VAS types](/marketplaces-and-platforms/seller-reference/vas-types).\n\nPrices ending in `_fixed` are in minor units of `vas_price_currency`. Prices ending in `_variable` are percentages.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"vas_type":{"type":"string","description":"A service type name from [VAS types](/marketplaces-and-platforms/seller-reference/vas-types), for example `Settlements`. Unknown names return error `24`."},"vas_api_key":{"type":"string","description":"A service's public ID, or an array of them."},"vas_payme_id":{"type":"string","description":"The `vas_guid` of one of the seller's services. Returns that service."},"language":{"type":"string","description":"Language of error messages: `he` (default) or `en`."}},"required":["payme_client_key","seller_payme_id"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","vas_type":"Settlements","language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"vas_payme_id":{"type":"string","description":"The `vas_payme_id` filter from the request, or `null`."},"items_count":{"type":"integer","description":"Number of services in `items`."},"items":{"type":"array","description":"The seller's services.","items":{"type":"object","properties":{"vas_description":{"type":"string","description":"Name of the service."},"vas_type":{"type":"string","description":"Service type name, see [VAS types](/marketplaces-and-platforms/seller-reference/vas-types)."},"vas_name":{"type":"string","description":"Plan name, for creation plans only. Otherwise `null`."},"vas_api_key":{"type":"string","description":"The service's public ID, or `null`."},"vas_guid":{"type":"string","description":"This seller's instance of the service."},"vas_is_active":{"type":"boolean","description":"`true` when the service is active for this seller."},"vas_payer_type":{"type":"integer","description":"Who pays for the service: `1` – partner, `2` – seller, `3` – reseller."},"vas_price_currency":{"type":"string","description":"Currency of the prices, ISO 4217, for example `ILS`."},"vas_price_setup_fixed":{"type":"integer","description":"One-time setup price, in minor units."},"vas_price_periodic_fixed":{"type":"integer","description":"Fixed periodic price, in minor units."},"vas_price_periodic_variable":{"type":"string","description":"Variable periodic price, percent."},"vas_price_usage_fixed":{"type":"integer","description":"Fixed price per use, in minor units."},"vas_price_usage_variable":{"type":"string","description":"Variable price per use, percent."},"vas_market_fee":{"type":"string","description":"Market fee set on this service, or `null`."},"vas_period":{"type":"integer","description":"Billing period: `1` – instant, `2` – daily, `3` – monthly, `4` – yearly."},"vas_data":{"type":"array","description":"Settings stored on the service. Their content depends on the service type."}}}}}},"example":{"status_code":0,"session":"a1B2c3D4","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","vas_payme_id":null,"items_count":1,"items":[{"vas_description":"עמלת סליקה","vas_type":"Settlements","vas_name":null,"vas_api_key":null,"vas_guid":"VASL1234-ABCD1234-EFGH5678-IJKL9012","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":[]}]}}}},"500":{"description":"Error, for example error `24`: unknown `vas_type`","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Invalid enum value","status_additional_info":null,"status_error_code":24,"session":"a1B2c3D4"}}}}}}},"/withdraw-balance":{"post":{"operationId":"post-withdraw-balance","summary":"Withdraw a seller's balance","tags":["Merchants Management"],"description":"Requests a payout of a seller's released balance in one currency to the seller's bank account. By default it withdraws the whole released balance. To withdraw a set amount, send `withdrawal_amount`. To withdraw specific transactions, send `transaction_ids`. A partner sends `payme_client_key` and the seller's `seller_payme_id`. A seller sends its own `seller_payme_id`.\n\nThe seller must be on the manual withdrawal plan (`seller_withdrawal_plan` `1` on [List sellers](/payments/query-apis/post-get-sellers)), approved by PayMe (`seller_approved`), and have bank details on file. Approval needs the seller's documents: see [File types](/marketplaces-and-platforms/seller-reference/file-types). The amount must be at least the minimum: 100.00 per currency (`10000` in minor units), unless PayMe set another value for your account.\n\nPayMe records the withdrawal, sends a `withdrawal-complete` callback, and transfers the money later. If the response has no `items`, no withdrawal was created. If the call times out, check [List withdrawals](/payments/query-apis/post-get-withdrawals) before you retry. For plans, timing and reconciliation, see [Withdrawals](/marketplaces-and-platforms/fees-and-payouts/withdrawals).\n\n### Errors\n\nEvery error returns `status_code` `1` with the code in `status_error_code`.\n\nCode | Meaning\n---|---\n`1` | `withdrawal_currency` is missing.\n`2` | A previous withdrawal is stuck on a funds mismatch. Contact PayMe support.\n`17` | `withdrawal_currency` holds more than one currency. Send one currency per request.\n`42` | `withdrawal_amount` isn't an integer.\n`109` | The seller isn't approved yet.\n`165` | The seller's bank details are missing.\n`171` | No released balance to withdraw, or `withdrawal_amount` is above it.\n`252` | Unknown `withdrawal_currency`.\n`907` | The seller is on an automatic (daily or monthly) withdrawal plan.\n`908` | The seller, or a listed transaction, is paid directly by the card companies.\n`913` | The amount is below the minimum, or `withdrawal_amount` isn't a positive integer.\n`998` | HTTP 429: another withdrawal for this seller is running. Wait and retry.\n`507` / `523` / `525` / `526` | A listed transaction is in another currency / not released yet / already withdrawn / not found for this seller.\n\nThe full list is on [Errors](/payments/getting-started/errors).\n\n### Callback\n\nWhen the withdrawal is recorded, before the bank transfer, PayMe sends a `withdrawal-complete` callback (`POST`, `x-www-form-urlencoded`) to your default callback URL. See [Callbacks](/payments/getting-started/callbacks).\n\nField | Description\n---|---\n`notify_type` | `withdrawal-complete`\n`payme_status` | `success`\n`status_code` | `0`\n`status_error_code` | `0`\n`seller_payme_id` | The seller's MPL, for example `MPLDEMO-MPLDEMO-MPLDEMO-1234567`.\n`seller_id` | Your own ID for the seller. Omitted when the seller has none.\n`sale_payme_code` | Always `0`.\n`tran_payme_code` | The withdrawal's ID: `withdrawal_id` in this response, `withdrawal_payme_code` on List withdrawals.\n`tran_created` | When the withdrawal was created, `yyyy-mm-dd hh:mm:ss`.\n`tran_type` | `40` (bank withdrawal).\n`tran_currency` | Currency, for example `ILS`.\n`tran_total` | Amount, in minor units (`10000` = 100.00).\n`tran_description` | A Hebrew label. Don't parse it.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payme_client_key":{"type":"string","description":"Your partner key. A seller calling for itself doesn't send it."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"withdrawal_currency":{"type":"string","description":"Currency to withdraw, a 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code such as `ILS`. One currency per request."},"withdrawal_amount":{"type":"integer","description":"Withdraw this amount of the released balance instead of all of it, in minor units (`50000` = 500.00). It must be at least the minimum and no more than the released balance. Ignored when you send `transaction_ids`."},"transaction_ids":{"type":"array","description":"Withdraw only these transactions: `payme_transaction_id` values from [List transactions](/payments/query-apis/post-get-transactions), for example `TRAN1499-869602B9-7QIUNKHI-F0SL1AOV`. Each must belong to the seller, be in `withdrawal_currency`, be released and not withdrawn already. PayMe also includes the other released transactions of the same sales, such as refunds, and lists them all in the response's `transaction_ids`."},"language":{"type":"string","description":"Language of error messages: `he` (default) or `en`."}},"required":["seller_payme_id","withdrawal_currency"]},"example":{"payme_client_key":"XXXXXXXX","seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","withdrawal_currency":"ILS","language":"en"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"page":{"type":"integer","description":"Always `1`."},"items_per_page":{"type":"integer","description":"Number of withdrawals in `items`."},"items_total":{"type":"integer","description":"Number of withdrawals in `items`."},"items":{"type":"array","description":"The withdrawals created. Missing when no withdrawal was created.","items":{"type":"object","properties":{"withdrawal_id":{"type":"integer","description":"The withdrawal's ID. The same number is `withdrawal_payme_code` on List withdrawals and `tran_payme_code` in the callback."},"withdrawal_currency":{"type":"string","description":"Withdrawal currency."},"withdrawal_total":{"type":"integer","description":"Withdrawal amount, in minor units."}}}},"transaction_ids":{"type":"array","description":"Partial withdrawals only: every transaction included, which can be more than you sent."}}},"example":{"status_code":0,"session":"a1B2c3D4","page":1,"items_per_page":1,"items_total":1,"items":[{"withdrawal_id":10001,"withdrawal_currency":"ILS","withdrawal_total":600000}]}}}},"500":{"description":"Error, for example error `171`: no released balance to withdraw","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"No available funds for withdrawal","status_additional_info":null,"status_error_code":171,"session":"a1B2c3D4"}}}}}}},"/sellers/{seller_payme_id}/public-keys":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-sellers-mpl-public-keys","summary":"List a seller's public keys","tags":["Merchants Management"],"description":"Returns the public keys of one of your sellers, including deactivated ones. Use a public key in browser code, for example to create Hosted Fields with `PayMe.create`. Never put the seller's MPL in browser code. Partners only: send your partner key in the `PayMe-Partner-Key` header.\n\n`create-seller` also returns the new seller's key as `seller_public_key`. See [Authentication](/payments/getting-started/authentication#the-public-key).\n\n### Errors\n\nHTTP status | Code | When\n---|---|---\n`500` | `1` | The `PayMe-Partner-Key` header is missing.\n`500` | `200` | The partner key matches no partner.\n`400` | `20` | The seller belongs to another partner (\"Partner-Seller inconsistency\").\n`404` | – | No seller has this MPL. The body is `{\"message\": \"…\"}`, not the PayMe error fields.\n","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":true,"description":"Your partner key (`payme_client_key`).","schema":{"type":"string"}},{"name":"seller_payme_id","in":"path","required":true,"description":"The seller's MPL (`seller_payme_id`). An unknown MPL returns HTTP 404.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"page":{"type":"integer","description":"Always `1`. The list isn't paginated."},"items_total":{"type":"integer","description":"Number of keys."},"items_per_page":{"type":"integer","description":"Number of keys (same as `items_total`)."},"seller_payme_id":{"type":"string","description":"The seller's MPL."},"items":{"type":"array","description":"The seller's public keys, active and deactivated.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The public key."},"description":{"type":"string","description":"Name of the key."}}}}}},"example":{"status_code":0,"session":"a1B2c3D4","page":1,"items_total":1,"items_per_page":1,"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","items":[{"uuid":"12345678-1234-4abc-9def-123456789012","description":"PayMe-Public-Key"}]}}}},"400":{"description":"Bad request: the seller belongs to another partner (error `20`)","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Validation error","status_additional_info":"Partner-Seller inconsistency","status_error_code":20,"session":"a1B2c3D4"}}}},"500":{"description":"Error, for example error `1`: the `PayMe-Partner-Key` header is missing","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"PayMe-Partner-Key","status_error_code":1,"session":"a1B2c3D4"}}}}}}},"/business-fields":{"get":{"security":[{"partnerKey":[]}],"operationId":"get-business-fields","summary":"List business fields","tags":["Merchants Management"],"description":"## Overview\n\nReturns PayMe's business fields (the seller's line of business). Send a field's `code` as `seller_person_business_type` when you [create](/payments/merchants-management/post-create-seller) or [update](/payments/merchants-management/post-update-seller) a seller. The full list with Hebrew and English names is on [Business field codes](/marketplaces-and-platforms/seller-reference/mcc-list).\n\nWithout a code in the path, only top-level fields (codes 10000 and above) are returned. Add `allow_children=true` to include their child fields. To get one field, add its code to the path: `GET /business-fields/{code}`. This also returns child fields and older codes below 10000. A code that doesn't exist returns `status_code` `0` with an empty `items`. A non-numeric code fails with error `10`.\n\nA code that is inactive is rejected by Create a seller with error `110`.\n\n## Authentication\n\nSend your partner key in the `PayMe-Partner-Key` header, or, as a seller, your MPL in the `PayMe-Merchant-Key` header. Keys in the query string are not read. Without either, the call fails with error `1` (`status_additional_info`: `payme_client_key`).\n","parameters":[{"name":"PayMe-Partner-Key","in":"header","required":false,"description":"Your partner key (`payme_client_key`). Required unless you send `PayMe-Merchant-Key`.","schema":{"type":"string"}},{"name":"PayMe-Merchant-Key","in":"header","required":false,"description":"The seller's MPL (`seller_payme_id`), instead of `PayMe-Partner-Key`.","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Response field to sort by: `code`, `name_intl` or `name_local`. Default `code`.","schema":{"type":"string"}},{"name":"sort_direction","in":"query","required":false,"description":"`desc` sorts descending. Any other value sorts ascending.","schema":{"type":"string"}},{"name":"language","in":"query","required":false,"description":"Language of `name_local`: `he` (default) or `en`. `es`, `ru` and `ar` are accepted but return the English name. Any other value falls back to `he` without an error.","schema":{"type":"string"}},{"name":"allow_children","in":"query","required":false,"description":"`true` also returns child business fields. Default `false`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"page":{"type":"integer","description":"Always `1`. The list isn't paginated."},"items_per_page":{"type":"integer","description":"Number of items returned (same as `items_total`)."},"items_total":{"type":"integer","description":"Number of items returned."},"language":{"type":"string","description":"Language used for `name_local`."},"items":{"type":"array","description":"Business fields, sorted by `sort_by`.","items":{"type":"object","properties":{"code":{"type":"integer","description":"Business field code. Send it as `seller_person_business_type`."},"name_intl":{"type":"string","description":"English name."},"name_local":{"type":"string","description":"Name in the requested `language`."}}}}}},"example":{"status_code":0,"page":1,"items_per_page":2,"items_total":2,"language":"he","items":[{"code":10000,"name_intl":"Nurseries","name_local":"משתלות"},{"code":10004,"name_intl":"Confectionery","name_local":"קונדיטוריה"}]}}}},"500":{"description":"Error, for example error `1`: no key was sent","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Required parameter is missing","status_additional_info":"payme_client_key","status_error_code":1,"session":"a1B2c3D4"}}}}}}},"/add-card-to-seller":{"post":{"operationId":"post-add-card-to-seller","summary":"Attach a saved card to a seller","tags":["Merchants Management"],"description":"Attaches a saved card, identified by its `buyer_key`, to a seller. A contract paid by credit card uses a card attached this way; see the [contracts overview](/b2b-payments/contracts).\n\nIf the card was saved by PayMe for a contract, it is assigned to this seller. Calling again for the same card isn't needed.\n\nThis endpoint sends no callback. The result, including the buyer token fields, is in the HTTP response: `status_code` `0` means success and `1` means failure.\n\nThe response holds the buyer's details, so handle it securely.\n\n### Errors\n\nHTTP status | Error code | Message | When\n---|---|---|---\n`500` | `900` | Please provide all required information in JSON format. Make sure to include 'Content-Type: application/json' header | The request is not JSON.\n`500` | `901` | Please verify that the JSON provided is valid | The JSON body is empty or invalid.\n`500` | `1` | Required parameter is missing | One of these is missing: `seller_payme_id`, `buyer_key`. `status_additional_info` names it.\n`500` | `251` | Seller was not found | The seller key is unknown.\n`500` | `163` | Account settings problem - please contact Customer Support | The seller is not active.\n`500` | `600` | Buyer not found | No buyer has this `buyer_key`.\n`500` | `604` | Buyer inactive | The buyer is inactive.\n`500` | `605` | The buyer was not captured using the provided seller | This seller may not use this buyer.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seller_payme_id":{"type":"string","description":"The seller's MPL: the seller the card is attached to."},"buyer_key":{"type":"string","description":"The saved card to attach, from [Capture a buyer token](/payments/tokenization/post-capture-buyer-token) or a sale callback."}},"required":["seller_payme_id","buyer_key"]},"example":{"seller_payme_id":"MPLDEMO-MPLDEMO-MPLDEMO-1234567","buyer_key":"BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567"}}}},"responses":{"200":{"description":"OK","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`0` on success."},"session":{"type":"string","description":"PayMe session ID."},"buyer_key":{"type":"string","description":"The buyer token (`buyer_key`) you sent."},"buyer_name":{"type":"string","description":"The buyer's name."},"buyer_email":{"type":"string","description":"The buyer's email address."},"buyer_phone":{"type":"string","description":"The buyer's phone number."},"buyer_card_mask":{"type":"string","description":"The masked card number."},"buyer_card_exp":{"type":"string","description":"The card expiry date, `MMYY`."},"buyer_social_id":{"type":"string","description":"The buyer's national ID number."},"buyer_is_permanent":{"type":"boolean","description":"Whether the buyer token is permanent."},"buyer_status":{"type":"string","description":"Always `null`; ignore it."}}},"example":{"status_code":0,"session":"a1B2c3D4","buyer_key":"BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567","buyer_name":"Example Buyer","buyer_email":"buyer@example.com","buyer_phone":"0500000001","buyer_card_mask":"458045******4580","buyer_card_exp":"1228","buyer_social_id":"123456782","buyer_is_permanent":false,"buyer_status":null}}}},"500":{"description":"Error, for example error `600`: no buyer has this `buyer_key`","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"`1` on failure."},"status_error_code":{"type":"integer","description":"PayMe error code. See [Errors](/payments/getting-started/errors)."},"status_error_details":{"type":"string","description":"Error message, in the request's `language`."},"status_additional_info":{"type":"string","description":"Extra detail, such as the name of the missing or invalid field. Can be `null`."},"session":{"type":"string","description":"PayMe session ID. Quote it when you contact support."}}},"example":{"status_code":1,"status_error_details":"Buyer not found","status_additional_info":null,"status_error_code":600,"session":"XXXXXXXX"}}}}}}}}}