Israeli Direct Debit

Availability. Israeli Direct Debit is offered to high-volume sellers only. It is enabled per account after approval by your PayMe sales representative; it is not self-service.

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.

Generating a new bank authorization

Prerequisites

PayMe enables Israeli direct debit on the account after approval. Until then, generate-sale returns 720.

The solution is based on our iframe, where the following details will be collected:

  1. Account type (Individual/Company/Non-Profit/etc)
  2. Account Owner Name
  3. Account Owner Social ID/Business Code
  4. Email Address
  5. Phone Number
  6. Bank
  7. Bank Branch
  8. Bank Account Number
  9. Signature

In order to create a new bank authorization request, you will need to initiate the following request:

POST https://<env>.payme.io/api/generate-sale

{
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sale_price": "1000",
    "currency": "ILS",
    "product_name": "Shirt",
    "sale_payment_method": "il-direct-debit",
    "sale_type": "token"
}

Send all of these fields: product_name and a numeric sale_price are required even though nothing is charged. currency is optional for the setup (the account's default is used), so send ILS.

The response will include a URL for our iframe for the user to insert the details:

{
    "status_code": 0,
    "sale_url": "https://sandbox.payme.io/sale/generate/SALEGUID",
    "payme_sale_id": "SALEGUID",
    "payme_sale_code": 123456,
    "price": 100,
    "transaction_id": "",
    "currency": "ILS",
    "sale_payment_method": "il-direct-debit"
}

Once the bank authorization request was successfully created, the token for the buyer will remain inactive until we receive an official update from the bank that the authorization was successfully created and the account can be charged. PayMe then sends sale-complete (or sale-failure if the bank rejects it), followed by sale-il-direct-debit-update, to your callback URL.

Creating a new payment request using the Israeli Direct Debit Payment Method

In order to create a new payment request using the IL DD, you will need to use our generate-sale API in the following form:

{
    "seller_payme_id": "MPLDEMO-MPLDEMO-MPLDEMO-1234567",
    "sale_price": "1000",
    "currency": "ILS",
    "product_name": "Shirt",
    "language": "en",
    "sale_payment_method": "il-direct-debit",
    "sale_type": "sale",
    "buyer_key": "BUYERDEMO-BUYERDEMO-BUYERDEMO-1234567"
}

If the charging request was successful, you will receive the following response:

{
    "status_code": 0,
    "payme_status": "success",
    "status_error_code": null,
    "payme_sale_id": "SALEGUID",
    "payme_sale_code": 1088759,
    "sale_created": "2022-07-03 08:52:16",
    "payme_sale_status": "initial",
    "sale_status": "initial",
    "currency": "ILS",
    "transaction_id": "",
    "is_token_sale": false,
    "price": 1000,
    "payme_signature": "signatureID",
    "sale_deferred_months": null,
    "payme_transaction_id": "TRANGUID",
    "payme_transaction_total": "1000",
    "payme_transaction_card_brand": "PrivateLabel",
    "payme_transaction_auth_number": null,
    "payme_transaction_voucher": null,
    "payme_transaction_emv_uid": null,
    "payme_transaction_acquirer": null,
    "payme_transaction_auth_source": null,
    "payme_transaction_card_issuer": null,
    "payme_transaction_credit_type": null,
    "buyer_name": "Ran Tester",
    "buyer_email": "TestTest@paymeservice.com",
    "buyer_phone": "05222222",
    "buyer_card_mask": null,
    "buyer_card_exp": null,
    "buyer_card_is_foreign": false,
    "buyer_social_id": "123456789",
    "installments": 1,
    "transaction_first_payment": "1000",
    "transaction_periodical_payment": 0,
    "sale_paid_date": "2022-07-03 08:54:10",
    "sale_release_date": null,
    "sale_3ds": false
}

In this phase, the payment request will go through a process of validation with the related bank. The approval will be received after 8 calendar days - a decline will be received earlier than that. Callbacks: sale-paid when the debit is submitted, sale-complete about 8 days later, or sale-failure if the bank returns it. See Callbacks.

Authorization Cancellations and Revokes

The bank is eligible to revoke an authorization at any point of time - this means that once an authorization is revoked, PayMe will update the token to be inactive and you won't be able to use it for new payments anymore. The update can be communicated using our callback system to your designated URL.