v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Recurring Charges

View

post/RecurringPayments/GetRecurringCharge

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

charge_uidstring required

Unique identifier for charge

terminal_uidstring required

Unique identifier for terminal

Response

200

idstring

uuidstring

recurring_idinteger

user_idinteger

source_idinteger

card_token_idinteger

statusinteger

{"stackTrail":"paths:/RecurringPayments/GetRecurringCharge:post:responses:200:content:application/json:schema:properties:transactions_approvals_id","oasType":"schema","type":"unknown"}

typeinteger

validboolean

amountnumber

{"stackTrail":"paths:/RecurringPayments/GetRecurringCharge:post:responses:200:content:application/json:schema:properties:extra_info","oasType":"schema","type":"unknown"}

charge_datestring

{"stackTrail":"paths:/RecurringPayments/GetRecurringCharge:post:responses:200:content:application/json:schema:properties:items","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/RecurringPayments/GetRecurringCharge:post:responses:200:content:application/json:schema:properties:execution_date","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

{"stackTrail":"paths:/RecurringPayments/GetRecurringCharge:post:responses:200:content:application/json:schema:properties:deleted_at","oasType":"schema","type":"unknown"}

Example response

{
  "id": "134",
  "uuid": "2601ax6c-b45a-421d-814f-f3bc6a6840f8",
  "recurring_id": 53,
  "user_id": 2,
  "source_id": 4,
  "card_token_id": 43,
  "valid": true,
  "charge_date": "2021-03-10",
  "created_at": "2021-01-20T14:46:34.499Z",
  "updated_at": "2021-01-20T14:46:34.499Z",
  "recurringPayment": {
    "id": "53",
    "uuid": "7389f623-6124-4bd5-91ab-e8f0fe73240a",
    "number": "rd506",
    "customer_id": 1,
    "card_token_id": 43,
    "currency_code": "ILS",
    "cashier_id": 2,
    "user_id": "2",
    "instant_first_payment": true,
    "customer_failure_email": true,
    "successful_invoice": true,
    "recurring_type": 1,
    "recurring_range": 4,
    "start_date": "2021-02-10",
    "number_of_charges": 5,
    "valid": true,
    "items": [
      {
        "product_uid": "ba1ac8a6-0e26-4bc7-b26c-675f87761c3a",
        "name": "מוצר כללי",
        "quantity": 1,
        "currency_code": "ILS",
        "quantity_price": 855,
        "amount_pay": 1000,
        "vat": 145,
        "quantity_price_including_vat": 1000,
        "product_id": "1",
        "vat_type": 1,
        "vat_percentage": 1700
      }
    ],
    "source_id": 4,
    "created_at": "2021-01-19T06:21:06.999Z",
    "updated_at": "2021-01-20T14:46:34.480Z",
    "cashier": {
      "id": "2",
      "uuid": "1bc7b1ax1-d90c-41ax3-a8bb-58ab8a3013ba",
      "company_id": "2",
      "name": "קופה כללית",
      "number": 1,
      "company_terminal_id": "2",
      "created_at": "2020-12-11T06:31:41.302Z",
      "updated_at": "2021-01-14T08:05:00.971Z"
    }
  },
  "cardToken": {
    "id": "43",
    "customer_id": 1,
    "valid": true,
    "card_token": "9ac92d49-fd83-48ec-ab8e-d180527957c30218",
    "last_4_digits": "0218",
    "card_date_mmyy": "0124",
    "clearing_id": 6,
    "brand_id": 2,
    "issuer_id": 1,
    "created_at": "2020-12-31T14:05:16.205Z",
    "updated_at": "2020-12-31T14:05:16.205Z"
  }
}