Sign in

v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Devices

TransactionByDevice

post/Device/TransactionByDevice

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

device_uidstring required

Unique Device Identifier (UID) from the PayPlus system

cashier_uidstring

unique identifier (UID) associated with a cashier account from the PayPlus system

charge_method0 | 1 | 2 | 4 required

Use this parameter to define the appropriate transaction action based on the customer's request and system requirements

0 - Check (J2) 1 - Charge (J4) 2 - Approval (J5) 4 - Refund (J4)

callback_urlstring

nullable (We will send you webhook once the transaction approved). Example: https://www.domain.com/callback/

create_tokenboolean

nullable (In case you have tokenization permission, you can decide if you would like to return the token of the customer for future charges)

initial_invoiceboolean

nullable (In case you have invoice company and it's activated in your payment page, you can decide if for spesfic transaction invoice will be initial or not, to use default please don't send this parameter at all)

custom_invoice_namestring

nullable (In case you have integrated invoice company you can decide if the invoice customer name will be different then the "customer_name" parameter in customer object)

amountnumber required
currency_codestring required
credit_terms1 | 6 | 8 required

1-regular OR 6-credit OR 8-payment

paying_vatboolean

nullable (In case you would like to that invoice / document will be with VAT or without VAT, This parameter is not required)

customer_uidstring

To allocate the payment to specific customer

extra_infostring
minimize_appboolean

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "transaction": {
      "uid": "4ff5d46b-4929-491a-896d-6f846fb7eddf",
      "number": "SLik8Y",
      "type": "EMV pinpad",
      "date": "2021-10-25 15:41:33",
      "status_code": "000",
      "currency": "ILS",
      "credit_terms": "regular",
      "payments": {
        "number_of_payments": 1
      },
      "approval_number": "4687869",
      "voucher_number": "13-001-056",
      "more_info": "transaction-test"
    },
    "data": {
      "customer_uid": "fee334d0-bb8b-489d-9b7b-51327d55fbc5",
      "terminal_uid": "b964a199-7176-4982-acbe-553decba2e67",
      "cashier_uid": "575bacea-22e1-41ad-ada9-6fc7a350a4c8",
      "cashier_name": "01",
      "items": [
        {
          "name": "חסה עגולה",
          "quantity": 1,
          "quantity_price": 4.27
        }
      ],
      "card_information": {
        "token": "19be1de9-a3e8-496d-8d61-38f3653431df8054",
        "four_digits": "8054",
        "expiry_month": "06",
        "expiry_year": "26",
        "clearing_id": 5,
        "brand_id": 10,
        "issuer_id": 1
      }
    }
  }
}