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

# IPN

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "Payment Pages"
    }
  ],
  "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": {
    "/PaymentPages/ipn": {
      "post": {
        "tags": [
          "Payment Pages"
        ],
        "summary": "IPN",
        "description": "",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "payment_request_uid": {
                    "type": "string",
                    "description": "required if transaction uid without value"
                  },
                  "transaction_uid": {
                    "type": "string",
                    "description": "required if payment request uid without value."
                  },
                  "related_transaction": {
                    "type": "boolean",
                    "description": "by default false, to receive all the related transactions for every transaction send true"
                  },
                  "approval_num": {
                    "type": "string",
                    "description": "Receive transaction by approval number, This number can be repeated in other previous of your transaction and therefore search by this field will draw the latest transaction"
                  },
                  "voucher_num": {
                    "type": "string",
                    "description": "Receive transaction by approval number, This number can be repeated in other previous of your transaction and therefore search by this field will draw the latest transaction"
                  },
                  "more_info": {
                    "type": "string",
                    "description": "Search by transaction more info in case you sent"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```