v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Transactions

Refund by Credit Card

Refund by Credit Card

post/Transactions/Refund

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

terminal_uidstring required

Unique identifier for terminal

{"stackTrail":"paths:/Transactions/Refund:post:requestBody:content:application/json:schema:properties:cashier_uid","oasType":"schema","type":"unknown"}

credit_terms1 | 6 | 8 required

1-regular OR 6-credit OR 8-payment

amountnumber required

currency_codestring required

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)

use_tokenboolean required

If true , token is required

tokenstring

Required only if use_token is true

customer_name_invoicestring

Required only if customer_uid is null and have integrated invoice system

customer_uidstring

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

idstring

Payer credit card holder identification number

initial_invoiceboolean

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

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)

notesstring

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "operation has been success"
  },
  "data": {
    "transaction": {
      "uid": "8a81c540-1eb5-4b08-a48d-19d6ca620724",
      "number": "cb648",
      "type": "internal_page",
      "date": "2021-01-07 16:31:19",
      "status_code": "000",
      "currency": "ILS",
      "credit_terms": "regular",
      "payments": {
        "number_of_payments": 1
      },
      "approval_number": "0000000",
      "voucher_number": "07-480-074",
      "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": 910,
          "discount_amount": 10,
          "discount_type": "amount",
          "discount_value": 10,
          "quantity": "1",
          "quantity_price": 747,
          "product_uid": "ba4c68a6-0e26-4bc7-b26c-675f87761c3a",
          "name": "Smart TV"
        }
      ],
      "card_information": {
        "four_digits": "1175",
        "expiry_month": "06",
        "expiry_year": "25",
        "clearing_id": 4,
        "brand_id": 1,
        "issuer_id": 4
      }
    }
  }
}