Sign in

v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Transactions

Charge Transaction (J4)

post/Transactions/Charge

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

terminal_uidstring required

Unique identifier for terminal

cashier_uidstring required

Unique identifier for cashier

amountnumber required
currency_codestring required
credit_terms1 | 6 | 8 required

1-regular OR 6-credit OR 8-payment

use_tokenboolean required

If true , token is required

tokenstring

Required only if use_token is true

initial_invoiceboolean

If sent the transactions will consider if to initial invoice or not, if not sent then will take the default setting

customer_name_invoicestring

Required only if customer_uid is null and have integrated invoice system

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)

add_datastring

SHOULD BE SENT JUST IF YOUR CREDIT CARD COMPANY OPENED THIS OPTION !!!

deferMonthsinteger

nullable (If you are using Club Codes [Kod Moadon] send the code in this field)

original_terminal_uidstring

In case you charging J5 transaction in another terminal, provide the original terminal of the original J5 tranasaction.

customer_uidstring

Mandatory if use_token is true, customer object can be used instead

idstring

Payer credit card holder identification number

extra_infostring
more_info_1string

nullable (Additional Information)

more_info_2string

nullable (Additional Information)

more_info_3string

nullable (Additional Information)

more_info_4string

nullable (Additional Information)

more_info_5string

nullable (Additional Information)

Example request

{
  "products": [
    {
      "discount_value": 10
    }
  ]
}

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "transaction": {
      "uid": "599dbe80-53bf-4e2b-9f66-e38d42b90b68",
      "number": "ha635",
      "type": "internal_page",
      "date": "2021-01-07 16:24:31",
      "status_code": "000",
      "currency": "ILS",
      "credit_terms": "credit",
      "payments": {
        "number_of_payments": 3
      },
      "approval_number": "0000000",
      "voucher_number": "07-480-067",
      "more_info": "Smart TV",
      "more_info_1": "Additional 1",
      "more_info_2": "Additional 2",
      "more_info_3": "Additional 3",
      "more_info_4": "Additional 4",
      "more_info_5": "Additional 5"
    },
    "data": {
      "customer_uid": "ef76432c-769a-43a6-ba7a-6f70272539d8",
      "terminal_uid": "97432e96-3c21-4eb2-9d64-1067e845b35a",
      "cashier_uid": "1bc7b001-d90c-43b3-a8bb-58ab8a3013ba",
      "items": [
        {
          "amount_pay": 100,
          "discount_amount": 10,
          "discount_type": "amount",
          "discount_value": 10,
          "quantity": "1",
          "quantity_price": 85.47,
          "product_uid": "ba4c68a6-0e26-4bc7-b26c-675f87761c3a",
          "name": "Smart TV"
        }
      ],
      "card_information": {
        "four_digits": "0218",
        "expiry_month": "01",
        "expiry_year": "24",
        "clearing_id": 6,
        "brand_id": 2,
        "issuer_id": 1
      }
    }
  }
}