v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Recurring Payments

View Recurring

This endpoint allows you to view a specific recurring payment.

get/RecurringPayments/{uid}/ViewRecurring

Path parameters

uidstring required

Recurring Payment unique identifier

Query parameters

terminal_uidstring

Terminal unique identifier

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Response

200

customer_uidstring

cashier_uidstring

card_tokenstring

currency_codestring

instant_first_paymentboolean

customer_failure_emailboolean

successful_invoiceboolean

send_customer_success_emailboolean

recurring_typeinteger

recurring_rangeinteger

start_datestring

number_of_chargesinteger

amountnumber

{"stackTrail":"paths:/RecurringPayments/{uid}/ViewRecurring:get:responses:200:content:application/json:schema:properties:one_time_items","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/RecurringPayments/{uid}/ViewRecurring:get:responses:200:content:application/json:schema:properties:one_time_charge_date","oasType":"schema","type":"unknown"}

numberstring

extra_infostring

uidstring

Example response

{
  "customer_uid": "ef76432c-769a-43a6-ba7a-6f70272539d8",
  "cashier_uid": "1bc7b001-d90c-43b3-a8bb-58ab8a3013ba",
  "card_token": "0868522e-ed12-43f1-bcfb-d4bdf0fbc1b71672",
  "currency_code": "ILS",
  "customer_failure_email": true,
  "send_customer_success_email": true,
  "recurring_range": 2,
  "start_date": "2020-12-22",
  "number_of_charges": 5,
  "items": [
    {
      "product_uid": "ba4c68a6-0e26-4bc7-b26c-675f87761c3a",
      "name": "מוצר כללי",
      "quantity": "5",
      "currency_code": "ILS",
      "quantity_price": 2,
      "amount_pay": 11.7,
      "vat": 1.7,
      "quantity_price_including_vat": 2.34,
      "product_id": "1",
      "vat_type": 1,
      "vat_percentage": 17
    }
  ],
  "number": "C13663",
  "uid": "ca168461-5613-42c6-a9ef-243fa0f91bfb"
}