Keep API reference

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.

Partner Authorization

• Prerequisites: Partner authorization layer protects the Partner's data on the Keep domain against unauthorized access and mutation.
• Authorization Flow: Keep uses OAuth 2.0 client credentials. POST /oauth2/token (form-encoded) with grant_type=client_credentials, client_id, client_secret and optional scope (partner-api or seller-api); send Authorization: Bearer <access_token>; refresh with grant_type=refresh_token. Use the lifetime returned in expires_in; when supplied, refresh_expires_in gives the refresh-token lifetime. Keep is served on https://<partner_domain>.keep.co.il; HTTPS only. Credentials come from your Account Manager and cannot be rotated by you.

Seller API

• List income documents: GET /seller/api/documents/income
• Create income document: POST /seller/api/documents/income
• Get income document: GET /seller/api/documents/income/{id}

Partners API

• Obtain access token: POST /oauth2/token
• Create seller: POST /api/public/sellers/create
• Get seller: GET /api/public/sellers/{sellerId}
• Get available plans: GET /api/public/plans
• List expenses: GET /api/public/expenses
• Upload expense document: POST /api/public/expenses
• Update expense: PATCH /api/public/expenses/{expenseId}
• Update seller: PUT /api/public/sellers/{sellerId}/update
• Set seller billing plan: POST /api/public/plans/activate
• List income documents: GET /partner/api/documents/income
• Create manual income document: POST /partner/api/documents/income/manual
• Get financial checkpoints: GET /partner/api/statistic/checkpoints
• Get tax predictions: GET /partner/api/statistic/tax-predictions