Marketplaces & Platforms

Migrated from Stoplight. Guides & Use Cases.

Overview

• Merchant Default URLs: Upon creating your Merchant account with us, you will be required to provide a few default URLs for various calls. More examples can be found further in the documentation.

Payments

• Apple Pay: The payment method is limited to be used in the following devices manufactured by Apple:
• Apple Pay - Full Flow Control: The payment method is limited to be used in the following devices manufactured by Apple:
• Google Pay: Google Pay™ allows your customers to pay quickly and securely using payment methods saved in their Google Account. Google Pay is fully compatible with PayMe’s products and features: You can use it for traditional payments and multi payments page.
• Bank transfer: 1. POST /pending-bank-transfer and get a synchronous response with "pending_transaction_id" "origin_payme_id" , "sale_status": "RECEIVED" and relevant bank details 2. Wait for a callback notification to the provided "sale_callback_url" URL. 3. On "sale_status": "PAID" - funds are transferred to the merchant account and fees are charged.
• Israeli Direct Debit: In order to create a direct debit mandate for Israeli customers, you can use our generate-sale API endpoint to complete the two actions of: 1. Generating a mandate request. 2. Generating a new payment request.
• Point Of Sale: A POS system allows your business to accept payments from customers and keep track of sales. It sounds simple enough, but the setup can work in different ways, depending on whether you sell online, have a physical storefront, or both.
• Multi Payment Page: Also known as “Template Sale”. Enables payments on a single sale link, by multiple buyers.

For example, you will be able to generate a single sale and share its payment link on any social network site to allow multiple customers to pay on their own.

Every payment will create a new sale with a different ID. Creation of a template sale should be done by adding the sale_type="template" attribute to the request:

• Multi Capture: The guide will be a run-through the process of using our Multi-Capture logic for card payments.
• Multi Capture Paypal: The guide will be a run-through the process of using our Multi-Capture logic for Paypal payments.
• Capture sale: Also known as “Pre-Authorization”. The requested amount gets reserved (blocked) on the credit card of the buyer for up to 168 hours. A following Capture request will trigger the actual settlement of the funds. Please note that attempting to Capture after the allowed period of time (168 hours) will result in an error.
• Create Payment With Buyer Key (Token): Allows for token capture upon the buyer's payment (submission of payment details).
• How to create subscription:

3D Secure

• 3D Secure Guide: 3-D Secure is a protocol designated to redurce fradulant transactions and protect merchants from losing the funds for those transactions. The name refers to the "three domains" which interact using the protocol: the merchant/acquirer domain, the issuer domain, and the interoperability domain. Our API is designed to allow platforms to offer a full payment solution as part of their product.Using the API you can allow sellers accept 3DSecure authorizations for credit card payments.
• 3D Secure as a Service: The standalone 3D Secure service enables you to leverage the 3D Secure capabilities of PayMe in an independent API request, without executing the usual purchase or authorization transaction that triggers 3D Secure authentication.

Integrations

• Hosted Fields JSAPI Guide: * jsFiddle
• Direct API - How to create and pay sale: To initiate and pay a sale, please adhere to the following steps:

Capabilities

• Pre-Fill payment page: You can pass your buyer's details to our payment page, to pre-fill the form.

Sellers

• Create Seller: This endpoint is relevant only to PayMe's partners.

Reporting

• Kinds of reports: Using our API and system, you can export different kinds of reports.
• Queries APIs guides: > For API reference, please head over to our APIs section using the sidebar on the left.

Lists & Statuses

• Sale Types: Sale Type number | Sale Type 1 |sale (J4) 5 |authorize (J5) 2 |token 3 |saleFromSubscription 4 |saleFromTemplate 5 |multiCapture 6 |customerDeposit 7 |credit 10 |template 11 |saleFromPaymentContract 12 |sellerToken
• Sale Statuses: Sale Type | Sale Status | Description 1 | initial | Creation status, a payment was not attempted 2 | completed | The sale was paid successfully 3 | refunded |The sale was fully refunded 4 | partial-refund|The sale was partially refunded 5 | authorized | The sale was authorized successfully 6 | failed | The sale failed 7 | chargeback|The sale was chargedbacked 8 | canceled|The sale was canceled 9 | voided|The authorization was fully voided
• Sale Callbacks: Once the sale is paid successfully, we will notify the marketplace with the sale details with a POST of type x-www-form-urlencoded request to the marketplace Callback URL.
• Transaction Types: Transaction Types | Description 1 | Sale 2 | Setup 10 | SubscriptionToken 20 | Token 30 | CustomerDeposit 40 | Authorization, Void 50 | Customer Sale 60 | Balance
• Transaction Statuses: Transaction Status | Status Description 1|pending 2|validated 3 |refunded 4 |partial refund 5 |failed 6 |chargeback 7 |chargeback-refund 8 |voided 9 |partial-void 10|partial-chargeback 11|partial-chargeback-refund
• Subscription Statuses: ID|Description 1|Initial - Not paid yet 2|Active - Paid successfully 3|Paused 4|Failed 5|Cancelled 6|Completed 76|Failed - Pending automatic retry
• Subscription Iteration Types: ID|Description 1|Daily 2|Weekly 3|Monthly 4|Annually
• Bank Authorization Statuses: Status | Description | Notes 1 | Bank authorization opened successfully 2 | Bank authorization failed 3 | Bank authorization canceled by the account owner| Meaning the buyer canceled the authorization in the bank app 5 | Authorization moved from previous account | Please notes that the buyer key stays the same 6 | Account changed | Please notes that the buyer key stays the same 13 | Frozen authorization reactivated | Meaning the buyer froze the authorization in the bank app
• Banks in Israel: Bank | Bank Number בנק יהב | 4 בנק הדואר | 9 בנק לאומי | 10 בנק הפועלים | 12 בנק אגוד לישראל | 13 בנק אוצר החייל | 14 בנק מרכנתיל דיסקונט | 17 בנק מזרחי טפחות | 20 HSBC | 23 UBANK | 26 הבין לאומי הראשון | 31 בנק ערבי ישראלי | 34 בנק אוף אינדיה | 39 בנק מסד | 46 בנק פאגי | 52 בנק ירושלים | 54 דקסיה ישראל | 68 בנק לאומי למשכנתאות | 77 משכן בנהפ למשכנתאות | 91 הבין לאומי למשכנתאות | 92
• File Types: Name|Code|Description Social Id|1|Social ID document (תעודת הזהות). For additional information see Note 3 above Bank Account Ownership|2|Proof of bank account ownership or a cancelled cheque photo (שיק מבוטל או אישור ניהול חשבון בנק). For additional information see Note 3 above Corporate Certificate|3|Incorporation document (תעודת התאגדות של עוסק פטור/עוסק מורשה/חברה בע"מ/עמותה). For additional information see Note 3 above
• Document Types: The documents you can generate are:
• MCC List: | PayMe MCC Code | Description in Hebrew | Description in English | | -------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
• Individual Seller Types: Code | Role 1| Owner 2| Signatory 4| Director 8| Executive 16| Back Office
• Seller Incorporation Types (IL): Code | Type in Hebrew | Type in English 1| פרטי|Individual 2|עוסק מורשה |Sole Proprietorship 3|חברה בע"מ |Incorporated Company 4| שותפות|Partnership 5| עוסק פטור|Exempt Company 6| עמותה|Charity (Non Profit) 7|שותפות מוגבלת |Limited Partnership 8| חברה ציבורית|Publicly Traded Company 9| אגודה שיתופית|Shared Cooperative 10|חברה לתועלת הציבור (חל"צ) |Public Benefit Company 295|ועד בית| House Committee
• VAS Types: | VAS Type | Description | |---------|------------------------| | 1 | Integration | | 2 | Payments | | 3 | Discount | | 4 | Merchandise | | 5 | Invoice | | 6 | Sms | | 7 | CreditMatch | | 8 | Antifraud | | 9 | Insurance |