Marketplaces & Platforms

How-to guides for platforms and marketplaces on PayMe: onboarding sellers, platform fees, withdrawals, the reference lists sellers need, and reporting across sellers.

Start Here

• Start here: build a platform or marketplace on PayMe: Map of the PayMe partner model. A partner holds payme_client_key and a client password; each seller has its own MPL (seller_payme_id), public key, balance and bank account. Steps: onboard sellers (create-seller, documents, approval), enable payment methods (vas-enable), create sales with the seller's MPL and market_fee, handle callbacks, pay out (withdrawals), report. PayMe sets partner-level defaults: callback and return URLs, required seller fields, withdrawal plan, price range, rate limit. Seller callbacks go to the partner's default callback URL.

Seller Onboarding

• Create sellers: Partner guide to onboarding sellers. Create a seller with POST /create-seller (payme_client_key required; PayMe sets the required fields per partner, error 19; 5 calls per minute per IP, error 998) and store the returned seller_payme_id (MPL), or send the seller the seller_dashboard_signup_link to finish on PayMe's onboarding pages. Upload documents with upload-seller-files. Sellers can take payments at once; payouts wait for PayMe's approval.
• Enable payment methods and services for your sellers: Partner guide to seller services (VAS). Sellers install Apple Pay, Google Pay and Bit from the dashboard app store. Partners call vas-enable with payme_client_key, seller_payme_id and the partner's vas_payme_id (from PayMe Partners); status_code 0 = on, 2 = Zendesk ticket, PayMe completes it. Apple Pay needs vas_data.websites (up to 99, domain file checked live, 703). Check with get-vas-seller (vas_type names, error 24; no callback). Turn off with vas-disable; then sales with that method fail 720. 703 = partner lacks the service.
• Onboard a seller, from creation to first payout: Partner guide to a seller's lifecycle. Collect details (PayMe sets required fields per partner, error 19). create-seller: store the MPL and public key, send seller_dashboard_signup_link; 5 calls/min per IP. Documents: 1 and 2 for every seller, 3 for most; 90-97 are personal (error 184). Approval: seller-approve callback and seller_approved on get-sellers; seller-update arrives during review. Then services, the first sale, and the first payout: approved, bank details, released funds, minimum 100.00; plans 1/2/3; errors 109, 907, 908, 913.

Fees and Payouts

• Platform fees: How a partner charges a platform fee on its sellers' sales. market_fee is a percent (0-60) set as the seller's default on create-seller or per sale on generate-sale; market_fee_fixed adds a fixed fee per sale in major units. Errors 304 and 308. The seller's default can't be changed with update-seller; contact PayMe. See the fee on get-sellers, get-sales and get-transactions.
• Withdrawals: How sellers get paid. seller_withdrawal_plan 1 (manual) sellers request payouts with withdraw-balance (whole released balance, withdrawal_amount, or transaction_ids); plans 2 and 3 are automatic (error 907); paid-directly sellers get error 908. The seller must be approved by PayMe (error 109). Track with get-withdrawals and get-future-withdrawals; the withdrawal-complete callback; common errors.

Seller Reference

• File types: Reference list of seller document type codes for upload-seller-files and seller_additional_details[].files[].type. Every seller needs 1 (ID) and 2 (bank account); 3 (corporate certificate) for all but private individuals, house committees and municipalities, which need 14+7 and 27+7. Codes 90-97 are individual documents attached to the seller's primary individual (error 184 with more than one individual). Unknown code: error 20.
• Business field codes (MCC): Reference list of PayMe business field codes (10000 and up, top-level fields and their children) with Hebrew and English names. Send the code as seller_person_business_type on create-seller or update-seller; an unknown or inactive code returns error 110. The live list is GET /business-fields (allow_children=true for child codes). The Hebrew name is authoritative.
• Individual roles: Role codes for individuals linked to a seller: 1 Owner, 2 Signatory, 4 Director, 8 Executive, 16 Back Office, 32 Charity Member, 64 Committee Member, 128 Corporate Officer. Send them as an array in seller_additional_details[].type on create-seller (required, error 160; unknown code error 24). Without additional individuals, the seller's own person is Owner and Signatory for a private individual or sole proprietorship, Back Office otherwise.
• Seller incorporation types (Israel): Israeli incorporation type codes for seller_inc on create-seller and update-seller (0 or 1 Individual, 2 Sole Proprietorship, 3 Incorporated Company, 4 Partnership, 5 Exempt Sole Proprietorship, 6 Charity, 7 Limited Partnership, 8 Publicly Traded Company, 9 Shared Cooperative, 10 Public Benefit Company, 295 House Committee, 296 Municipalities and councils). The type must match seller_address_country, and seller_inc_code must fit the type's rule, otherwise error 114.
• VAS types: List of vas_type values for PayMe value-added services (VAS). The API takes and returns the type name (case-insensitive), for example AlternativePaymentMethod for Apple Pay and Google Pay; numeric codes are rejected with error 24. Used by vas-enable and get-vas-seller.

Reporting

• Reporting across your sellers: How a partner reports across its sellers with the query APIs: send payme_client_key (body or PayMe-Partner-Key header) and optionally seller_payme_id (up to 100). Recipes for volume and refunds (get-transactions), active subscriptions (get-subscriptions), seller counts and balances (get-sellers, not api_mode slim), payouts (get-withdrawals, get-future-withdrawals), paging up to 500 per page and rate limits.