# PayMe at a Glance

This page lists only what the PayMe documentation states. Gaps are marked **TO CONFIRM**.

## What PayMe offers

PayMe's Payments API is "designed to allow platforms to offer a full payment solution as part of their product."  With it you can:

- create and manage merchants on your platform; 
- accept credit-card payments and other payment methods; 
- create recurring payments (subscriptions); 
- use hosted (secured) payment pages; 
- tokenize cards for delayed and future payments; 
- charge a platform (market) fee on each transaction; 
- query sellers, transactions, subscriptions and withdrawals. 

### APIs in this documentation

| API | What it covers |
|-----|----------------|
| [Payments](/payments/introduction/getting-started) | Sales (hosted payment page, hosted fields, direct API), Apple Pay, Google Pay, Israeli direct debit, tokenization, subscriptions, refunds / capture / void, 3D Secure (including a standalone 3D Secure service), invoices, point-of-sale devices, merchant management for partners, and query APIs.  |
| [B2B Payments](/b2b-payments/contracts/post-user) | Payment contracts (send a payment or a payment request between businesses) and transfers between wallets.  |
| [Keep](/keep/partner-authorization/prerequisites) | APIs for PayMe's accounting product: sellers, income documents (invoices, receipts), expenses, tax and VAT.  |
| [Products and Customers](/products-and-customers/authentication/post-auth-token) | Create, list, update and delete products and customers.  |

Mobile: an iOS SDK is available. 

## Integration options

| Option | In one line |
|--------|-------------|
| Hosted Payment Page | The buyer pays on PayMe's secure page (`sale_url`, shown as an IFRAME or redirect); PayMe carries the PCI DSS burden. |
| Hosted Fields (JSAPI) | Payment fields embedded in your page with PayMe's JavaScript library. |
| Direct API | Your server sends card details to PayMe; you must meet PCI DSS level 1 yourself. |



## Payment methods

The `sale_payment_method` values documented are: 

`credit-card`, `bank-transfer`, `paypal`, `alipay-qr`, `alipay-online`, `funds-transfer`, `cash`, `cheque`, `echeck`, `bit`, `bacs`, `sepa`, `apple-pay`, `il-direct-debit`, `verifone-prepaid`, `google-pay`. Use `multi` to let the buyer choose on one checkout page. 

Card networks named in the docs: Visa, Mastercard, American Express, Diners, Discover, JCB and Isracard (test cards).  Google Pay supports Visa, Mastercard, American Express, Discover and JCB. 

Installments: 1–12 fixed, or let the buyer choose up to 3, 6, 9 or 12 (`103`, `106`, `109`, `112`). 

## Currencies

Sale currency is a 3-letter ISO 4217 code.  Supported currencies, subject to your account configuration:

ILS, USD, EUR, GBP, TRY, CHF, SEK, NOK, CAD, ZAR, JPY, AUD, AED, ARS, BHD, BRL, CNY, INR, KRW, KWD, KZT, MXN, NGN, PLN, RON, RUB, SAR, UAH, PHP, VND, HKD.

- Each account has its own allowed set; any other currency returns error `252`.
- ILS only: Israeli direct debit, Bit, and any sale with more than one installment.



- Sandbox test cards accept ILS, USD and EUR (the local Israeli test card accepts ILS only). 
- Keep income documents: "currently only ILS supported". 

## Countries

The documentation is Israel-centred: Israeli bank codes, Israeli business incorporation types, Israeli social ID fields, and Israeli direct debit.  Test data also exists for SEPA and BACS accounts.  The payment page collects a ZIP code for cards issued in the USA, Canada and the United Kingdom. 

> ⚠ TO CONFIRM: In which countries can merchants be onboarded, and from which countries can buyers pay? [Q45]

## Amounts and limits

- Amounts are in minor units (50.75 → `5075`). 
- Default `sale_price` range: `500`–`4000000` minor units, the same in every currency and payment method (so `500` is 5.00 ILS or USD but 500 JPY). PayMe can set different limits per account; out of range returns error `352`. Token sales use a fixed price of `100`. 
- An authorization (J5) reserves funds for up to 168 hours; capture is allowed once. 
- Rate limit: `generate-sale`, `pay-sale` and `capture-sale` share a per-seller limit, by default 100 requests per 10 seconds (may differ per account); over the limit returns HTTP 429. See [Idempotency and retries](/payments/getting-started/idempotency-and-retries). 

> ⚠ TO CONFIRM: Is 100 requests per 10 seconds per seller also the default in **production**? [Q28]

## Environments

| Environment | Base URL |
|-------------|----------|
| Sandbox | `https://sandbox.payme.io/api/` |
| Production | `https://live.payme.io/api/` |

 Details: [Environments](/payments/getting-started/environments).

## Compliance

- With the Hosted Payment Page, responsibility for PCI DSS lies with PayMe. 
- With the Direct API, the merchant must meet PCI DSS level 1. 
- Tokenization reduces the scope of PCI DSS requirements for recurring payments. 
- 3D Secure is supported, including as a standalone service. 

> ⚠ TO CONFIRM: What is PayMe's own PCI DSS certification level, and which licence or regulator applies to PayMe? [Q46]

## Contact

- General contact form: <https://payme.io/contact-us/> 
- Support email (given for adding Google Pay card networks): `support@payme.io` 
- Keep API keys come from your Account Manager. 

> ⚠ TO CONFIRM: What is the official developer-support channel (email, form, hours), and is `support@payme.io` the right address for integration questions? [Q47]

## Machine-readable docs

Every page is available as Markdown by appending `.md` to its URL; each API project publishes an OpenAPI file at `/<project>/openapi.json`; the site index for AI agents is `/llms.txt`.