v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Recurring Payments

View

This endpoint allows you to view a list of recurring payments.

get/RecurringPayments/View

Query parameters

terminal_uidstring required

Terminal unique identifier

customer_uidstring

Customer unique identifier

searchstring

Filter by search input

skipstring

Example:0

Optional Query variable, From where you want to start take records.

takestring

Example:5

Optional Query variable required if skip have some value. Max 500. This means that you want take 5 records.

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Response

200

pagesinteger

countinteger

Example response

{
  "data": [
    {
      "uid": "7389f623-60d4-4bd5-937b-e8f0fe73240a",
      "number": "Aj156",
      "created_at": "19/01/2021",
      "customer_name": "לקוח כללי",
      "customer_uid": "ef76432c-769a-43a6-ba7a-6f70272539d8",
      "each_payment_amount": 10,
      "number_of_charges": 5,
      "cc_number": "0218",
      "cc_expiration": "0124",
      "start_date": "2021-02-10",
      "first_charge_date": "2021-02-10",
      "valid": true,
      "recurring_type": "weekly",
      "cashier_name": "קופה כללית",
      "currency_code": "ILS",
      "recurring_range": 4
    }
  ],
  "pages": 1,
  "count": 11
}