Payments API reference

Migrated from Stoplight. Payments - API Reference.

Introduction

Getting Started: Our API is designed to allow platforms to offer a full payment solution as part of their product.
Sandbox and Production URLs: In order to work with the API, you should use the service URLs according to the required environments, Sandbox or Production.When interacting with the API, make sure you point to the correct environment, with the correct credentials. Both URLs will be stated next to each function.
Test Cards and Payment Methods: Please use the following credit card when integrating only in the Sandbox environment.
Value Added Services: At PayMe, We go beyond traditional financial solutions to offer a comprehensive suite of value-added services. These services are designed to enhance our clients' financial experiences and empower them with the tools they need for success. From the creation of invoices and security services to seamless integration with third-party platforms, our value-added services cater to the diverse needs of your business.
Payment Options: We have three integration options: - [Hosted Payment Page](/payments-migrated/api?v=tag:Hosted Payment Page) - Hosted Fields - JSAPI - Direct API

Generate Payment with Token: How to call POST /generate-sale for Hosted Fields - JSAPI.

Available Payment Methods: As PayMe offers different payment methods, you can use the sale_payment_method parameter in generate-sale to set your desired payment method.
Pay Sale: POST /pay-sale

Generate New Authorization: How to call POST /generate-sale for IL Direct Debit.
Generate New Payment: How to call POST /generate-sale for IL Direct Debit.

Generate: POST /generate-subscription
Recurring Payments: Recurring payments help you to oversee regular payments for subscriptions, providing convenience to customers and predictable revenue streams for your business.
Pay: POST /pay-subscription
Cancel: POST /cancel-subscription
Pause: POST /pause-subscription
Resume: PATCH /subscriptions/{sub_payme_id}/resume
Update Price: PATCH /subscriptions/{sub_id}/set-price

Platforms & Marketplaces: We allow platforms and marketplaces to manage merchants. In order to accomplish this goal, we require the marketplace to collect certain details during a merchant's registration. Once the merchant is registered, the marketplace is required to convey the required information to us through a dedicated API. Upon completion, the API will return the new merchant information within the our system.
Partial Balance Withdraw: POST /partial-withdraw
VAS Charge: POST /vas-links/{vasGuid}/charge
Collect Negative Wallet: POST /collect-negative-wallet
Generate Face-To-Face Validation Link: POST /scanovate/flows/{flow_id}
Additional Services Enablement: How to call POST /vas-enable for Platforms & Marketplaces - Internal.
Additional Services Disable: POST /vas-disable

Generate Sale with 3D Secure: How to call POST /generate-sale for Generate a Sale with 3D Secure.

List Sales: POST /get-sales
Reporting & Data: Access preconfigured reports to gain insight into essential activities, such as sales, transactions, subscriptions, and balance adjustments.
List Transactions: POST /get-transactions
List Subscriptions: POST /get-subscriptions
List Sellers: POST /get-sellers
List Past Withdrawals: POST /get-withdrawals
List Future Withdrawals: POST /get-future-withdrawals
Aggregated Wallets Data: GET /funds-transfer/aggregated
List of available banks: GET /banks/{country_iso_code}
Wallet to Wallet transfers: GET /funds-transfer
Withdrawal Correlation: POST /credit-match

iOS SDK: You can use the PayMe (Isracard Global) iOS SDK to implement payments on iOS devices. The guide covers building and importing the PMLib.framework, initializing the SDK, and integrating the Isracard Global API to pay a sale, pay a subscription, and capture a buyer.