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

# Charged

# 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/Charged": {
      "get": {
        "tags": [
          "Reports - Recurring Payments"
        ],
        "summary": "Charged",
        "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\": 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\": \"17/01/2021\",\n\"execution_date\": \"19/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"3760e3e7-5cc4-461f-8838-dc2c518546cf\"\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\": \"13/01/2021\",\n\"execution_date\": \"14/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 180,\n\"uid\": \"da6417a3-8caf-442d-9b49-af0cae9495a9\"\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\": \"13/01/2021\",\n\"execution_date\": \"14/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 150,\n\"uid\": \"ee5c8a57-ab6d-4b23-856e-965ec8eaece9\"\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\": \"12/01/2021\",\n\"execution_date\": \"14/01/2021\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 200,\n\"uid\": \"c210844b-275a-4315-a7a9-88af93c4011e\"\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\": \"24/12/2020\",\n\"execution_date\": \"24/12/2020\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"5ad117cc-6bbc-4213-8b1e-ab8fa5a5d5ae\"\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\": \"24/12/2020\",\n\"execution_date\": \"24/12/2020\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"fc3baff3-ad18-4fb9-898f-fd395fb329e9\"\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\": \"24/12/2020\",\n\"execution_date\": \"24/12/2020\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"1864b51c-9011-4304-b94a-44b5516ad091\"\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\": \"24/12/2020\",\n\"execution_date\": \"24/12/2020\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 10,\n\"uid\": \"8d27f340-9d3d-4079-9c86-ab8750728559\"\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\": \"24/12/2020\",\n\"execution_date\": \"24/12/2020\",\n\"charge_type\": \"recurring\",\n\"card_number\": \"1175\",\n\"card_expiry\": \"0626\",\n\"amount\": 4.68,\n\"uid\": \"38202492-a8ea-4942-b2dc-36cbeda383ba\"\n}\n],\n\"total_charges\": 9,\n\"total_amount\": 574.04,\n\"count\": 9,\n\"pages\": 1\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```