v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Transactions

Refund By Transaction UID

post/Transactions/RefundByTransactionUID

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

transaction_uidstring required

The transaction UID you received from the original J5 transaction

amountnumber required

Amount you would like to charge but not more then the original J5 transaction

more_infostring

If is partial amount, invoice product line will be taken from this field if received

cvvstring

If your terminal in the credit companies is required CVV, then you have to pass this field, otherwise the transaction will be failed

initial_invoiceboolean

As long your account connected to Invoice+ we will generate document for this action

Example request

{
  "items": {
    "discount_value": 10
  }
}

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "transaction": {
      "uid": "e1396310-e3f8-461f-b80a-55b1954311359",
      "number": "gf8708",
      "type": "internal_page",
      "date": "2021-02-17 19:40:16",
      "status_code": "000",
      "currency": "ILS",
      "credit_terms": "regular",
      "payments": {
        "number_of_payments": 1
      },
      "approval_number": "3148090",
      "voucher_number": "50-001-187"
    },
    "data": {
      "customer_uid": "c3703ae5-9cab-43b6-8bf5-0af239dc87ae",
      "terminal_uid": "83d218ac-478c-413a-ac79-fe63fe966de9",
      "cashier_uid": "d74f98d3-0437-41ba-9b53-4439c06b4a8d",
      "items": [
        {
          "amount_pay": 50,
          "quantity": 1,
          "quantity_price": 42.73,
          "vat": 7.27,
          "product_uid": "d6536a11-1fce-49c3-87a6-ab0261da1cd2",
          "name": "test"
        }
      ],
      "card_information": {
        "token": "3639a5a7-7883-4e37-b96c-e46640d6f8fd1175",
        "four_digits": "1175",
        "expiry_month": "06",
        "expiry_year": "25",
        "clearing_id": 1,
        "brand_id": 10,
        "issuer_id": 1
      }
    }
  }
}