---
updatedAt: 2025-05-28T09:45:39.000Z
agentTools:
  projectIndex: https://docs.payplus.co.il/llms.txt
---

# Future

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Reports - Recurring Payments"
    }
  ],
  "servers": [
    {
      "url": "https://restapi.payplus.co.il/api/v1.0/",
      "description": "Production"
    },
    {
      "url": "https://restapidev.payplus.co.il/api/v1.0/",
      "description": "Staging"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/RecurringPaymentsReports/Future": {
      "get": {
        "tags": [
          "Reports - Recurring Payments"
        ],
        "summary": "Future",
        "description": "",
        "parameters": [
          {
            "name": "terminal_uid",
            "in": "query",
            "description": "terminal_uid",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency_code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "default": "ILS"
            }
          },
          {
            "name": "customer_uid",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from_date",
            "in": "query",
            "description": "EX: 2020-12-01",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "till_date",
            "in": "query",
            "description": "EX: 2020-12-01",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "schema": {
              "type": "string",
              "description": "Optional Query variable, From where you want to start take records.in this example you start from the first record"
            }
          },
          {
            "name": "take",
            "in": "query",
            "schema": {
              "type": "string",
              "description": "Optional Query variable required if skip have some value. max 500. This means that you want take 5 records."
            }
          },
          {
            "name": "api-key",
            "in": "header",
            "description": "API Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secret-key",
            "in": "header",
            "description": "Secret Key",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"data\": [\n{\n\"recurring_number\": 3879210,\n\"recurring_uid\": \"dfe3b27f-a07b-4dcb-b08b-0368efbf8216\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"18/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"0b89adbe-8639-4089-a5e8-08a54e2164d2\"\n},\n{\n\"recurring_number\": 1384644,\n\"recurring_uid\": \"7088b78a-ea4c-42a8-964a-0a7e42d433c8\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"18/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"36517a5f-a72e-4968-bbd5-a786b917f4ac\"\n},\n{\n\"recurring_number\": 3879210,\n\"recurring_uid\": \"dfe3b27f-a07b-4dcb-b08b-0368efbf8216\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"19/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"2a692190-fb15-402a-ad43-6f78fdf6a87e\"\n},\n{\n\"recurring_number\": 1384644,\n\"recurring_uid\": \"7088b78a-ea4c-42a8-964a-0a7e42d433c8\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"19/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"7f354907-ee62-49b7-8fc2-7ce8e7011d50\"\n},\n{\n\"recurring_number\": 3879210,\n\"recurring_uid\": \"dfe3b27f-a07b-4dcb-b08b-0368efbf8216\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"20/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"9ad896d1-6f16-44dd-9fa3-135032fdffcc\"\n},\n{\n\"recurring_number\": 1384644,\n\"recurring_uid\": \"7088b78a-ea4c-42a8-964a-0a7e42d433c8\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"20/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"72dafa52-4889-4d7f-9b64-18f00c9b2850\"\n},\n{\n\"recurring_number\": 9816,\n\"recurring_uid\": \"b14e8daa-6945-4854-9f29-4fc7a22f1718\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"22/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"8730\",\n\"card_expiry\": \"0521\",\n\"amount\": 200,\n\"uid\": \"632c96bb-3be5-48e5-b610-c58377bc160a\"\n},\n{\n\"recurring_number\": 9816,\n\"recurring_uid\": \"b14e8daa-6945-4854-9f29-4fc7a22f1718\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"23/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"8730\",\n\"card_expiry\": \"0521\",\n\"amount\": 200,\n\"uid\": \"3361ffec-8b9d-41c7-b5db-153631b21793\"\n},\n{\n\"recurring_number\": 9816,\n\"recurring_uid\": \"b14e8daa-6945-4854-9f29-4fc7a22f1718\",\n\"customer_name\": \"לקוח כללי\",\n\"customer_uid\": \"ef76432c-769a-43a6-ba7a-6f70272539d8\",\n\"currency_code\": \"ILS\",\n\"date_to_charge\": \"24/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"8730\",\n\"card_expiry\": \"0521\",\n\"amount\": 200,\n\"uid\": \"bcfb51a7-a272-4dec-be73-c5814d8f9062\"\n}\n],\n\"total_charges\": 9,\n\"total_amount\": 64404,\n\"count\": 9,\n\"pages\": 1\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "recurring_number": {
                            "type": "integer",
                            "example": 3879210,
                            "default": 0
                          },
                          "recurring_uid": {
                            "type": "string",
                            "example": "dfe3b27f-a07b-4dcb-b08b-0368efbf8216"
                          },
                          "customer_name": {
                            "type": "string",
                            "example": "לקוח כללי"
                          },
                          "customer_uid": {
                            "type": "string",
                            "example": "ef76432c-769a-43a6-ba7a-6f70272539d8"
                          },
                          "currency_code": {
                            "type": "string",
                            "example": "ILS"
                          },
                          "date_to_charge": {
                            "type": "string",
                            "example": "18/01/2021"
                          },
                          "charge_type": {
                            "type": "string",
                            "example": "recurring"
                          },
                          "card_number": {
                            "type": "string",
                            "example": "1175"
                          },
                          "card_expiry": {
                            "type": "string",
                            "example": "0626"
                          },
                          "amount": {
                            "type": "number"
                          },
                          "uid": {
                            "type": "string",
                            "example": "0b89adbe-8639-4089-a5e8-08a54e2164d2"
                          }
                        }
                      }
                    },
                    "total_charges": {
                      "type": "integer",
                      "example": 9,
                      "default": 0
                    },
                    "total_amount": {
                      "type": "integer",
                      "example": 64404,
                      "default": 0
                    },
                    "count": {
                      "type": "integer",
                      "example": 9,
                      "default": 0
                    },
                    "pages": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```