PayPlus

https://docs.payplus.co.il/
Admin
PayPlus is a comprehensive payment processing API platform that enables businesses to manage...
Tokens:164,370
Snippets:413
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### OpenAPI Schema Example

Source: https://docs.payplus.co.il/reference/post_sms-sendsinglesmsmessage

Example structure for document and customer data objects.

```json
{
  "type": "string",
  "example": "472819632332439"
},
"brand": {
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Company Name"
    },
    "uuid": {
      "type": "string",
      "example": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
    }
  }
},
"copyDocAddress": {
  "type": "string",
  "example": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
},
"currency_code": {
  "type": "string",
  "example": "ILS"
},
"customer": {
  "type": "object",
  "properties": {
    "customer_name": {
      "type": "string",
      "example": "John Doe"
    },
    "email": {
      "type": "string",
      "example": "johndoe@example.com"
    },
    "phone": {
      "type": "string",
      "example": "123456789"
    },
    "subject_code": {
      "type": "string",
      "example": "987654321"
    },
    "uuid": {
      "type": "string",
      "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
    },
    "vat_number": {
      "type": "string",
      "example": "1231231"
    }
  }
},
"customer_uuid": {
  "type": "string",
  "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
},
"docUID": {
  "type": "string",
  "example": "1fa79282-61d1-4898-b7b9-afa67f46d34a"
},
"doc_date": {
  "type": "string",
  "example": "2022-11-15"
},
"doc_type": {
  "type": "string",
  "example": "inv_tax"
},
"more_info": {},
"number": {
  "type": "string",
  "example": "SCP/50042"
},
"originalDocAddress": {
  "type": "string",
  "example": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
},
"total_items_base_currency": {
  "type": "integer",
  "example": 150,
  "default": 0
},
"validDocumentGenerated": {
  "type": "boolean",
  "example": true,
  "default": true
}
```

--------------------------------

### OpenAPI Response Example

Source: https://docs.payplus.co.il/reference/get_banks-companybankaccounts

Example of a successful response containing a bank account identifier.

```json
"example": "b1b3f508-7e53-409f-a79c-99db0672bccb"
```

--------------------------------

### Job Movement Response Examples

Source: https://docs.payplus.co.il/reference/post_delayed-jobs-create-new-job-movementsjournal

Examples of successful and empty responses for job movement queries.

```json
[
{
"code": "inv_proforma",
"type_code": 300
},
{
"code": "inv_tax",
"type_code": 305
},
{
"code": "inv_receipt",
"type_code": 400
},
{
"code": "inv_tax_receipt",
"type_code": 320
},
{
"code": "inv_refund",
"type_code": 330
},
{
"code": "crt_delivery",
"type_code": 200
},
{
"code": "crt_return",
"type_code": 210
},
{
"code": "order_purchase",
"type_code": 500
},
{
"code": "purchase",
"type_code": 100
}
]
```

```json
{}
```

--------------------------------

### 400 Error Response Examples

Source: https://docs.payplus.co.il/reference/wittix-cards-get

Examples of error responses for missing cards or vouchers.

```json
{
  "results": {
    "status": "error",
    "code": -4,
    "description": "CARD_NOT_FOUND",
    "message": "Card not found"
  },
  "data": null
}
```

```json
{
  "results": {
    "status": "error",
    "code": -4,
    "description": "VOUCHER_NOT_FOUND",
    "message": "Voucher not found"
  },
  "data": null
}
```

--------------------------------

### Transaction Approval Schema Examples

Source: https://docs.payplus.co.il/reference/post_transactions-approval

Example values for product and card information fields within the transaction approval object.

```json
"quantity": {
  "type": "string",
  "example": "1"
}
```

```json
"quantity_price": {
  "type": "number",
  "example": 85.47,
  "default": 0
}
```

```json
"product_uid": {
  "type": "string",
  "example": "ba4c68a6-0e26-4bc7-b26c-675f87761c3a"
}
```

```json
"name": {
  "type": "string",
  "example": "Smart TV"
}
```

```json
"four_digits": {
  "type": "string",
  "example": "0218"
}
```

```json
"expiry_month": {
  "type": "string",
  "example": "01"
}
```

```json
"expiry_year": {
  "type": "string",
  "example": "24"
}
```

```json
"clearing_id": {
  "type": "integer",
  "example": 6,
  "default": 0
}
```

```json
"brand_id": {
  "type": "integer",
  "example": 2,
  "default": 0
}
```

```json
"issuer_id": {
  "type": "integer",
  "example": 1,
  "default": 0
}
```

--------------------------------

### Document Schema Example

Source: https://docs.payplus.co.il/reference/get_sms-listgroup

Example structure for document metadata including UUIDs, dates, and document types.

```json
{
  "uuid": {
    "type": "string",
    "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
  },
  "vat_number": {
    "type": "string",
    "example": "1231231"
  }
}
```

```json
{
  "customer_uuid": {
    "type": "string",
    "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
  },
  "docUID": {
    "type": "string",
    "example": "1fa79282-61d1-4898-b7b9-afa67f46d34a"
  },
  "doc_date": {
    "type": "string",
    "example": "2022-11-15"
  },
  "doc_type": {
    "type": "string",
    "example": "inv_tax"
  },
  "more_info": {},
  "number": {
    "type": "string",
    "example": "SCP/50042"
  },
  "originalDocAddress": {
    "type": "string",
    "example": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
  },
  "total_items_base_currency": {
    "type": "integer",
    "example": 150,
    "default": 0
  },
  "validDocumentGenerated": {
    "type": "boolean",
    "example": true,
    "default": true
  }
}
```

--------------------------------

### API Response Schema Example

Source: https://docs.payplus.co.il/reference/get_sms-messageslist

Example structure for a successful API response containing document details and customer information.

```json
{
  "example": "987654321"
},
"uuid": {
  "type": "string",
  "example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
},
"vat_number": {
  "type": "string",
  "example": "1231231"
}
}
},
"customer_uuid": {
"type": "string",
"example": "faa6280f-dba5-4889-9b15-de60e1527bdc"
},
"docUID": {
"type": "string",
"example": "1fa79282-61d1-4898-b7b9-afa67f46d34a"
},
"doc_date": {
"type": "string",
"example": "2022-11-15"
},
"doc_type": {
"type": "string",
"example": "inv_tax"
},
"more_info": {},
"number": {
"type": "string",
"example": "SCP/50042"
},
"originalDocAddress": {
"type": "string",
"example": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
},
"total_items_base_currency": {
"type": "integer",
"example": 150,
"default": 0
},
"validDocumentGenerated": {
"type": "boolean",
"example": true,
"default": true
}
```

--------------------------------

### OpenAPI Response Example Fields

Source: https://docs.payplus.co.il/reference/get_yourdomain-yourendpoint

Example JSON structure for response fields including document URLs, integrator names, and status codes.

```json
"example": "https://invoice.company.co.il/front/documents/get/17d2201b-1313-43ee-b9d1-0569ffad7951/copy"
},
"integrator_name": {
  "type": "string",
  "example": "Invoice Company"
},
"status": {
  "type": "string",
  "example": "Success"
},
"brand_name": {
  "type": "string",
  "example": "PayPlus External Brand Name"
}
```

--------------------------------

### 401 Error Response Example

Source: https://docs.payplus.co.il/reference/wittix-cards-list

Example of a 401 error response returned when an invalid access token is provided.

```json
"401": {
            "description": "Error response envelope",
            "content": {
              "application/json": {
                "examples": {
                  "Error - Missing Permission": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -1,
                        "description": "INVALID_ACCESS_TOKEN",
                        "message": "Invalid access token"
                      },
                      "data": null
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "additionalProperties": true,
                  "required": [
                    "results",
                    "data"
                  ],
                  "properties": {
                    "results": {
                      "type": "object",
                      "additionalProperties": true,
                      "required": [
                        "status",
                        "code",
                        "description",
                        "message"
                      ],
                      "properties": {
                        "status": {
                          "type": "string"
                        },
                        "code": {
                          "type": "integer"
                        },
                        "description": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "nullable": true,
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          }
```

--------------------------------

### Document Retrieval Response Example

Source: https://docs.payplus.co.il/reference/get_books-docs-list

Example JSON response returned by the document retrieval endpoint.

```json
{
"barcode": "472819632332439",
"brand": {
"name": "Company Name",
"uuid": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
},
"copyDocAddress": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
"currency_code": "ILS",
"customer": {
"customer_name": "John Doe",
"email": "johndoe@example.com",
"phone": "123456789",
"subject_code": "987654321",
"uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
"vat_number": "1231231"
},
"customer_uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
"docUID": "1fa79282-61d1-4898-b7b9-afa67f46d34a",
"doc_date": "2022-11-15",
"doc_type": "inv_tax",
"more_info": null,
"number": "SCP/50042",
"originalDocAddress": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
"total_items_base_currency": 150,
"validDocumentGenerated": true
}
```

--------------------------------

### Error Response Example

Source: https://docs.payplus.co.il/reference/post_paymentpages-generatelink

The response returned when the requested payment page cannot be located.

```json
can-not-find-payment-page
```

--------------------------------

### OpenAPI definition for Get document types

Source: https://docs.payplus.co.il/reference/get_books-doc-types

The OpenAPI specification for the /books/doc_types endpoint, including request parameters and response examples.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Invoice+ - Misc"
    }
  ],
  "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": {
    "/books/doc_types": {
      "get": {
        "tags": [
          "Invoice+ - Misc"
        ],
        "summary": "Get document types",
        "description": "",
        "parameters": [
          {
            "name": "language_code",
            "in": "query",
            "description": "Preferred response language Example: he.",
            "schema": {
              "type": "string"
            }
          },
          {
            "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{\n\"code\": \"inv_proforma\",\n\"type_code\": 300\n},\n{\n\"code\": \"inv_tax\",\n\"type_code\": 305\n},\n{\n\"code\": \"inv_receipt\",\n\"type_code\": 400\n},\n{\n\"code\": \"inv_tax_receipt\",\n\"type_code\": 320\n},\n{\n\"code\": \"inv_refund\",\n\"type_code\": 330\n},\n{\n\"code\": \"crt_delivery\",\n\"type_code\": 200\n},\n{\n\"code\": \"crt_return\",\n\"type_code\": 210\n},\n{\n\"code\": \"order_purchase\",\n\"type_code\": 500\n},\n{\n\"code\": \"purchase\",\n\"type_code\": 100\n}\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "example": "inv_proforma"
                      },
                      "type_code": {
                        "type": "integer",
                        "example": 300,
                        "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
  }
}
```

--------------------------------

### POST /products/add

Source: https://docs.payplus.co.il/reference/post_products-add

Adds a new product to the system with optional percentage discount and guide document URL.

```APIDOC
## POST /products/add

### Description
Adds a new product to the system.

### Method
POST

### Endpoint
/products/add

### Parameters
#### Request Body
- **percentage_discount** (number) - Optional - Percentage discount for the product. This is a discount that will be applied to the product price as a percentage.
- **guide_document_url** (string) - Optional - Mostly used for invoices to send manual documentation of a product when customer buying product.

### Response
#### Success Response (200)
- **Result** (object) - Empty object indicating success.

#### Error Response (400)
- **Result** (object) - Empty object indicating a bad request.
```

--------------------------------

### OpenAPI Response Examples

Source: https://docs.payplus.co.il/reference/post_products-update-uid

JSON response structures for successful and failed product update requests.

```json
{
  "description": "200",
  "content": {
    "application/json": {
      "examples": {
        "Result": {
          "value": "{}"
        }
      },
      "schema": {
        "type": "object",
        "properties": {}
      }
    }
  }
}
```

```json
{
  "description": "400",
  "content": {
    "application/json": {
      "examples": {
        "Result": {
          "value": "{}"
        }
      },
      "schema": {
        "type": "object",
        "properties": {}
      }
    }
  }
}
```

--------------------------------

### POST /Products/Add

Source: https://docs.payplus.co.il/reference/post_products-add

Creates a new product in the catalog. Requires API and Secret keys in the headers.

```APIDOC
## POST /Products/Add

### Description
This endpoint allows you to create products. You can specify details such as category, name, price, currency, VAT type, and additional product information. The product will be added to your catalog and can be used in transactions, recurring payments, Invoice+, etc.

### Method
POST

### Endpoint
/Products/Add

### Parameters
#### Header Parameters
- **api-key** (string) - Required - API Key
- **secret-key** (string) - Required - Secret Key

#### Request Body
- **category_uids** (array) - Optional - Array of strings, each string is a different category_uid. This allows you to assign your product to multiple categories. If not set, the product will be assigned to system's default category.
- **name** (string) - Required - Product name. This is a required field and should be unique for each product for better identification.
- **valid** (boolean) - Optional - Sets if the product is valid or not. If set to false, the product will not be available accross the system.
- **price** (integer) - Required - Sell price
- **currency_code** (string) - Required - Currency code (ILS, USD, EUR, GPB)
- **vat_type** (integer) - Required - 0 - VAT Included, 1 - VAT Not Included, 2 - VAT Exempt
- **barcode** (string) - Optional - Barcode of the product.
- **value** (string) - Optional - Cost price
- **description** (string) - Optional - Product description.
- **fixed_amount_discount** (integer) - Optional - Fixed amount discount for the product.
- **percentage_discount** (integer) - Optional - Percentage discount for the product.
```

--------------------------------

### Successful Response Example

Source: https://docs.payplus.co.il/reference/create-a-resource

The JSON structure returned upon a successful resource creation operation.

```json
{
"results": {
"status": "success",
"code": 0,
"description": "operation has been success"
},
"data": {
"customer_uid": "84aa6e4e-fe42-4d5f-b9cd-59dbc3817f10"
}
}
```

--------------------------------

### Initialize Hosted Fields DOM

Source: https://docs.payplus.co.il/reference/hosted-fields

Create a new instance of the PayPlusHostedFieldsDom object to begin the integration.

```javascript
const hf = new PayPlusHostedFieldsDom();
```

--------------------------------

### POST /customers

Source: https://docs.payplus.co.il/reference/create-a-resource

Creates a new customer record in the system.

```APIDOC
## POST /customers

### Description
Creates a new customer resource within the PayPlus system.

### Method
POST

### Endpoint
/customers

### Request Body
- **business_address** (string) - Optional - Business address of the customer.
- **business_city** (string) - Optional - Business city.
- **business_postal_code** (string) - Optional - Business postal code.
- **business_country_iso** (string) - Optional - Business country code (default: IL).
- **subject_code** (string) - Optional - External customer number in other ERP or other systems.
- **communication_email** (string) - Optional - Email for communication purposes.

### Response
#### Success Response (200)
- **results** (object) - Status information of the operation.
- **data** (object) - Contains the customer_uid of the created resource.

#### Response Example
{
  "results": {
    "status": "success",
    "code": 0,
    "description": "operation has been success"
  },
  "data": {
    "customer_uid": "84aa6e4e-fe42-4d5f-b9cd-59dbc3817f10"
  }
}
```

--------------------------------

### Withdrawal Error Response Examples

Source: https://docs.payplus.co.il/reference/wittix-transactions-withdraw

Examples of error responses returned when a withdrawal fails due to insufficient balance or invalid card information.

```json
"Error - Insufficient Balance": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -3,
                        "description": "INSUFFICIENT_BALANCE",
                        "message": "Insufficient card balance"
                      },
                      "data": null
                    }
                  },
                  "Error - Card Not Found": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -4,
                        "description": "CARD_NOT_FOUND",
                        "message": "Card not found"
                      },
                      "data": null
                    }
                  }
```

--------------------------------

### Initialize Payment Page

Source: https://docs.payplus.co.il/reference/hosted-fields

Initializes the payment page using parameters retrieved from the server and handles the initialization promise.

```javascript
$.get("payment.php", async (resp) => {
	if (resp.results.status == "success") {
		try {
			await hf.CreatePaymentPage({
				hosted_fields_uuid: resp.data.hosted_fields_uuid,
				page_request_uid: resp.data.page_request_uid,
				origin: 'https://restapidev.payplus.co.il'
			});
		} catch (error) {
			alert(error);
		}
		hf.InitPaymentPage.then((data) => {
			$("#create-payment-form").hide();
			$("#payment-form").show();
		});
	} else {
		alert(resp.results.message);
	}
});
```

--------------------------------

### OpenAPI Specification for Get Document

Source: https://docs.payplus.co.il/reference/get-document-data-copy-copy

The OpenAPI definition for the GET request to retrieve document data, including path parameters, required headers, and response schema.

```json
{
"openapi": "3.1.0",
"info": {
"title": "PayPlus - API Documentation - Production",
"version": "1.0"
},
"tags": [
{
"name": "Invoice+ - Documents"
}
],
"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": {
"/books/docs/getBy/unique_identifier/{unique_identifier}": {
"get": {
"tags": [
"Invoice+ - Documents"
],
"summary": "Get document by Unique Identifier",
"description": "",
"operationId": "get-document-data-copy-copy",
"parameters": [
{
"name": "unique_identifier",
"in": "path",
"description": "Unique identifier string as submitted upon doc creation",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "brand_uuid",
"in": "query",
"description": "Document''s brand UUID Example: a5f514de-c8c8-262a-ac31-31d609f3550a.",
"schema": {
"type": "string"
}
},
{
"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\"barcode\": \"472819632332439\",\n\"brand\": {\n\"name\": \"Company Name\",\n\"uuid\": \"67a8cc93-75ac-4832-8386-3eb5b24bf3d0\"\n},\n\"copyDocAddress\": \"https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf\",\n\"currency_code\": \"ILS\",\n\"customer\": {\n\"customer_name\": \"John Doe\",\n\"email\": \"johndoe@example.com\",\n\"phone\": \"123456789\",\n\"subject_code\": \"987654321\",\n\"uuid\": \"faa6280f-dba5-4889-9b15-de60e1527bdc\",\n\"vat_number\": \"1231231\"\n},\n\"customer_uuid\": \"faa6280f-dba5-4889-9b15-de60e1527bdc\",\n\"docUID\": \"1fa79282-61d1-4898-b7b9-afa67f46d34a\",\n\"doc_date\": \"2022-11-15\",\n\"doc_type\": \"inv_tax\",\n\"more_info\": null,\n\"number\": \"SCP/50042\",\n\"originalDocAddress\": \"https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf\",\n\"total_items_base_currency\": 150,\n\"validDocumentGenerated\": true\n}"
}
},
"schema": {
"type": "object",
"properties": {
"barcode": {
"type": "string",
"example": "472819632332439"
},
"brand": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Company Name"
},
"uuid": {
"type": "string",
"example": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
}
}
},
"copyDocAddress": {
"type": "string",
"example": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf"
},
"currency_code": {
"type": "string",
"example": "ILS"
},
"customer": {
"type": "object",
"properties": {
"customer_name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"phone": {
"type": "string",
"example": "123456789"
}
}
}
}
}
}
}
}
}
}
}
```

--------------------------------

### GET /Products/View

Source: https://docs.payplus.co.il/reference/get_products-view

Retrieves a list of products based on optional filters and pagination settings.

```APIDOC
## GET /Products/View

### Description
This endpoint allows you to retrieve a list of products with optional filters for UID, currency code, or barcode.

### Method
GET

### Endpoint
/Products/View

### Parameters
#### Query Parameters
- **barcode** (string) - Optional - View a specific product by its barcode.
- **currency_code** (string) - Optional - View all products with the same currency code (ILS, USD, EUR, GPB).
- **uid** (string) - Optional - View a specific product by its UID.
- **skip** (string) - Optional - From where you want to start take records.
- **take** (string) - Optional - Max 500. Number of records to take.

### Headers
- **api-key** (string) - Required - API Key
- **secret-key** (string) - Required - Secret Key

### Response
#### Success Response (200)
- **Result** (object) - Returns a list of products.

#### Error Response (400)
- **Result** (object) - Returns error details.
```

--------------------------------

### GET /recurringpayments/reports/future

Source: https://docs.payplus.co.il/reference/get_recurringpaymentsreports-future

Retrieves a report of future recurring payments.

```APIDOC
## GET /recurringpayments/reports/future

### Description
Retrieves a list of future recurring payments scheduled for processing.

### Method
GET

### Endpoint
/recurringpayments/reports/future

### Response
#### Success Response (200)
- **total_charges** (integer) - Total number of charges
- **total_amount** (integer) - Total sum of charges
- **count** (integer) - Number of items returned
- **pages** (integer) - Total number of pages
- **data** (array) - List of recurring payment objects

#### Response Example
{
  "total_charges": 9,
  "total_amount": 64404,
  "count": 9,
  "pages": 1,
  "data": [
    {
      "uid": "0b89adbe-8639-4089-a5e8-08a54e2164d2",
      "currency_code": "ILS",
      "date_to_charge": "18/01/2021",
      "charge_type": "recurring",
      "card_number": "1175",
      "card_expiry": "0626",
      "amount": 7156
    }
  ]
}
```

--------------------------------

### POST /Customers/Add

Source: https://docs.payplus.co.il/reference/create-a-resource

Creates a new customer in the PayPlus system.

```APIDOC
## POST /Customers/Add

### Description
This endpoint allows you to create a new customer in the system.

### Method
POST

### Endpoint
https://restapi.payplus.co.il/api/v1.0/Customers/Add

### Parameters
#### Header Parameters
- **api-key** (string) - Required - API Key
- **secret-key** (string) - Required - Secret Key

#### Request Body
- **email** (string) - Required - Customer email address.
- **customer_name** (string) - Required - Customer name.
- **paying_vat** (boolean) - Optional - Let's the system know if the customer is paying VAT or not. Default: true
- **vat_number** (integer) - Optional - Customer or Company VAT number.
- **customer_number** (string) - Optional - Internal customer number in the system.
- **notes** (string) - Optional - Notes, comments, or additional information about the customer.
- **phone** (string) - Optional - Customer phone number.
- **contacts** (array) - Optional - Contact details associated with the customer.
```

--------------------------------

### GET /recurringpaymentsreports/daily

Source: https://docs.payplus.co.il/reference/get_recurringpaymentsreports-daily

Retrieves the daily report for recurring payments.

```APIDOC
## GET /recurringpaymentsreports/daily

### Description
Retrieves a daily report of recurring payments, including transaction counts and currency information.

### Method
GET

### Endpoint
/recurringpaymentsreports/daily

### Response
#### Success Response (200)
- **data** (array) - List of daily report entries
- **count** (integer) - Total number of records
- **pages** (integer) - Total number of pages

#### Response Example
{
  "data": [
    {
      "debit": 1610,
      "total": 10,
      "currency_code": "ILS"
    }
  ],
  "count": 6,
  "pages": 1
}

#### Error Response (400)
- **Result** (object) - Empty object returned on bad request
```

--------------------------------

### OpenAPI Definition for Add Product

Source: https://docs.payplus.co.il/reference/post_products-add

The OpenAPI specification for the product creation endpoint, including authentication headers and request body schema.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Products"
    }
  ],
  "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": {
    "/Products/Add": {
      "post": {
        "tags": [
          "Products"
        ],
        "summary": "Add",
        "description": "This endpoint allows you to create products.\nYou can specify details such as category, name, price, currency, VAT type, and additional product information.\nThe product will be added to your catalog and can be used in transactions, recurring payments, Invoice+, etc.",
        "parameters": [
          {
            "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"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "category_uid",
                  "name",
                  "price",
                  "currency_code",
                  "vat_type"
                ],
                "properties": {
                  "category_uids": {
                    "type": "array",
                    "description": "Array of strings, each string is a different category_uid.\nThis allows you to assign your product to multiple categories.\nIf not set, the product will be assigned to system's default category.",
                    "items": {
                      "type": "string"
                    }
                  },
                  "name": {
                    "type": "string",
                    "description": "Product name.\nThis is a required field and should be unique for each product for better identification."
                  },
                  "valid": {
                    "type": "boolean",
                    "description": "Sets if the product is valid or not.\nIf set to false, the product will not be available accross the system.",
                    "default": true
                  },
                  "price": {
                    "type": "integer",
                    "description": "Sell price",
                    "format": "int"
                  },
                  "currency_code": {
                    "type": "string",
                    "enum": [
                      "ILS",
                      "USD",
                      "EUR",
                      "GPB"
                    ]
                  },
                  "vat_type": {
                    "type": "integer",
                    "format": "int",
                    "description": "0 - VAT Included\n1 - VAT Not Included\n2 - VAT Exempt",
                    "enum": [
                      0,
                      1,
                      2
                    ]
                  },
                  "barcode": {
                    "type": "string",
                    "description": "Barcode of the product.\nThis is an optional field, but it can be used to identify the product in a more convenient way."
                  },
                  "value": {
                    "type": "string",
                    "description": "Cost price"
                  },
                  "description": {
                    "type": "string",
                    "description": "Product description, can be used for additional information about the product."
                  },
                  "fixed_amount_discount": {
                    "type": "integer",
                    "format": "flout",
                    "description": "Fixed amount discount for the product.\nThis is a discount that will be applied to the product price."
                  },
                  "percentage_discount": {
                    "type": "integer",
                    "format": "flout",
```

--------------------------------

### GET /MyCashier

Source: https://docs.payplus.co.il/reference/mycashier-1

Retrieves a list of cashiers associated with the account.

```APIDOC
## GET /MyCashier

### Description
Retrieves a list of cashiers associated with the account.

### Method
GET

### Endpoint
/MyCashier

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier of the cashier.
- **name** (string) - The name of the cashier branch.
- **number** (integer) - The cashier number.
- **company_terminal_uid** (string) - The company terminal UID.

#### Response Example
[
  {
    "uuid": "0863cc9e-54cc-4ebc-aa5d-01925bbf86f5",
    "name": "סניף ת״א",
    "number": 1,
    "company_terminal_uid": "1"
  },
  {
    "uuid": "283cbe0e-440b-41c3-b90c-8f2a86ffbafd",
    "name": "סניף ראשל״צ",
    "number": 2,
    "company_terminal_id": "2"
  }
]
```

--------------------------------

### GET /MyTerminals

Source: https://docs.payplus.co.il/reference/isuerscompanies-copy

Retrieves a list of terminals associated with the account.

```APIDOC
## GET /MyTerminals

### Description
Retrieves a list of terminals associated with the account.

### Method
GET

### Endpoint
/MyTerminals

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier of the terminal.
- **terminal_type_id** (integer) - The ID representing the type of terminal.
- **name_terminal** (string) - The name of the terminal.
- **status** (boolean) - The active status of the terminal.
- **merchant_number** (string) - The merchant number associated with the terminal.

#### Response Example
[
  {
    "uuid": "55b1f178-6467-4cb2-8e37-ef60b15bdf9d",
    "terminal_type_id": 2,
    "name_terminal": "NEWTerminalShva",
    "status": true,
    "merchant_number": "0963595010"
  }
]
```

--------------------------------

### GET /recurringpayments/reports/charged

Source: https://docs.payplus.co.il/reference/get_recurringpaymentsreports-charged

Retrieves a list of charged recurring payments.

```APIDOC
## GET /recurringpayments/reports/charged

### Description
Retrieves a list of recurring payments that have been successfully charged.

### Method
GET

### Endpoint
/recurringpayments/reports/charged

### Response
#### Success Response (200)
- **data** (array) - List of charged recurring payments
- **total_charges** (integer) - Total number of charges
- **total_amount** (number) - Total sum of charges
- **count** (integer) - Number of items in the current page
- **pages** (integer) - Total number of pages

#### Response Example
{
  "data": [
    {
      "recurring_number": 1384644,
      "recurring_uid": "7088b78a-ea4c-42a8-964a-0a7e42d433c8",
      "customer_name": "לקוח כללי",
      "customer_uid": "ef76432c-769a-43a6-ba7a-6f70272539d8",
      "currency_code": "ILS",
      "date_to_charge": "17/01/2021",
      "execution_date": "19/01/2021",
      "charge_type": "recurring",
      "card_number": "1175",
      "card_expiry": "0626",
      "amount": 10,
      "uid": "3760e3e7-5cc4-461f-8838-dc2c518546cf"
    }
  ],
  "total_charges": 9,
  "total_amount": 574.04,
  "count": 9,
  "pages": 1
}
```

--------------------------------

### Successful Response Example

Source: https://docs.payplus.co.il/reference/post_paymentpages-generatelink

The JSON structure returned upon a successful generation of a payment page link.

```json
{
"results": {
"status": "success",
"code": 0,
"description": "payment page link is been generated"
},
"data": {
"page_request_uid": "f33f7a1f-5ea7-4857-992a-2da95b369f53",
"payment_page_link": "https://paymentsdev.payplus.co.il/f33f7a1f-5ea7-4857-992a-2da95b369f53",
"qr_code_image": "https://restapidev.payplus.co.il/api/payment-pages/payment-request/f33f7a1f-5ea7-4857-992a-2da95b369f53/qr-code"
}
}
```

--------------------------------

### GET /Deposit/View/{deposit_uid}

Source: https://docs.payplus.co.il/reference/get_deposit-view-deposit-uid

Retrieves information for a specific deposit.

```APIDOC
## GET /Deposit/View/{deposit_uid}

### Description
Retrieves the details of a specific deposit identified by its unique ID.

### Method
GET

### Endpoint
/Deposit/View/{deposit_uid}

### Parameters
#### Path Parameters
- **deposit_uid** (string) - Required - The unique identifier of the deposit.

#### Query Parameters
- **terminal_uid** (string) - Required - The unique identifier of the terminal.
- **currency_code** (string) - Required - The currency code for the deposit.

#### Headers
- **api-key** (string) - Required - API Key
- **secret-key** (string) - Required - Secret Key

### Response
#### Success Response (200)
- **Result** (object) - The deposit details.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### GET /failure-redirect-response

Source: https://docs.payplus.co.il/reference/get_failure-redirect-response

Retrieves the details of a failed transaction redirect.

```APIDOC
## GET /failure-redirect-response

### Description
Retrieves the details of a failed transaction redirect.

### Method
GET

### Endpoint
/failure-redirect-response

### Response
#### Success Response (200)
- **transaction_uid** (string) - Unique identifier for the transaction
- **page_request_uid** (string) - Unique identifier for the page request
- **type** (string) - Type of transaction
- **method** (string) - Payment method used
- **number** (string) - Partial card number
- **date** (string) - Date and time of the transaction
- **status** (string) - Status of the transaction
- **status_code** (string) - Status code of the failure
- **status_description** (string) - Description of the failure status
- **amount** (number) - Transaction amount
- **currency** (string) - Currency code
- **credit_terms** (string) - Credit terms
- **number_of_payments** (integer) - Number of payments
- **first_payment_amount** (number|null) - Amount of the first payment
- **rest_payments_amount** (number|null) - Amount of the remaining payments
- **secure3D_status** (boolean) - 3D Secure status
- **secure3D_tracking** (boolean) - 3D Secure tracking status
- **approval_num** (string|null) - Approval number
- **voucher_num** (string) - Voucher number
- **more_info** (string|null) - Additional information
- **customer_name** (string) - Customer name
- **identification_number** (string) - Customer identification number
- **customer_uid** (string) - Customer unique identifier
- **terminal_uid** (string) - Terminal unique identifier

#### Response Example
{
  "transaction_uid": "db0a3cb5-5168-4df7-830c-ca0b88184613",
  "page_request_uid": "f33f7a1f-5ea7-4857-992a-2da95b369f53",
  "type": "Charge",
  "method": "credit-card",
  "number": "7212",
  "date": "2021-01-28 15:35:55",
  "status": "rejected",
  "status_code": "003",
  "status_description": "התקשר לחברת האשראי",
  "amount": 0,
  "currency": "ILS",
  "credit_terms": "regular",
  "number_of_payments": 1,
  "first_payment_amount": null,
  "rest_payments_amount": null,
  "secure3D_status": false,
  "secure3D_tracking": false,
  "approval_num": null,
  "voucher_num": "28-480-715",
  "more_info": null,
  "customer_name": "יוסי אלימלך",
  "identification_number": "014440022",
  "customer_uid": "c01dd650-9f8a-4d42-8f92-a4809a74e5d4"
}
```
Tokens:
Raw