PayMe API Documentation

Developer documentation for PayMe, an Israeli payments provider: the Payments API for accepting card, wallet and bank payments through a hosted payment page, hosted fields or a direct API, plus the B2B Payments, Keep accounting and Products & Customers APIs, with sandbox and production environments.

• Marketplaces & Platforms: How-to guides for platforms and marketplaces on PayMe: onboarding sellers, Apple Pay, Google Pay, bank transfer, Israeli direct debit, capture, 3D Secure and reporting, plus reference lists of statuses, types and codes.
• Payments: API reference for accepting payments with PayMe — sales via hosted payment page, hosted fields or direct API, tokens, subscriptions, refunds and captures, 3D Secure, invoices and point-of-sale. Start with Getting Started for credentials, environments and a first sale.
• B2B Payments: API reference for business-to-business payments: create payment contracts that send a payment or request one, manage their invoices and recipients, and transfer funds between wallets.
• Keep: APIs for Keep, PayMe's accounting product: partners create and manage sellers, income documents, expenses, and tax and VAT balances, authenticating with OAuth 2.0 client credentials.
• Products and Customers: API reference for storing a seller's product catalogue and customer records: create, list, update and delete products and customers, authenticated with a JWT from POST /auth/token.