---
updatedAt: 2025-06-05T14:36:38.000Z
agentTools:
  projectIndex: https://docs.payplus.co.il/llms.txt
---

# Credit Card Renewal Notification

This endpoint is used to notify the customer about the renewal of their credit card for a recurring payment, a payment page link will be attached to the email.
There's a possibility to disable sending the email and return a payment page link instead for the representative to fill in the new credit card details.

* Requires a payment page associated with the recurring payment terminal.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PayPlus - API Documentation - Production",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "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": {
    "/RecurringPayments/CreditCardRenewal/{recurring_uid}": {
      "post": {
        "tags": [
          "Recurring Payments"
        ],
        "summary": "Credit Card Renewal Notification",
        "description": "This endpoint is used to notify the customer about the renewal of their credit card for a recurring payment, a payment page link will be attached to the email.\nThere's a possibility to disable sending the email and return a payment page link instead for the representative to fill in the new credit card details.\n\n* Requires a payment page associated with the recurring payment terminal.",
        "parameters": [
          {
            "name": "recurring_uid",
            "in": "path",
            "description": "Recurring payment unique identifier",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "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": [
                  "terminal_uid"
                ],
                "properties": {
                  "terminal_uid": {
                    "type": "string",
                    "description": "Terminal unique identifier"
                  },
                  "disable_send_email": {
                    "type": "boolean",
                    "description": "If set to true, a notification email will not be sent to the customer and payment page link will be returned instead.\nThe payment page link returned, allows to fill in the new credit card details.\nThis is useful for cases where there isn't a need to send an email to the customer, for example, when the customer is already on the phone with the representative and the representative fills in the new credit card details."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"result\": {\n\"status\": \"success\",\n\"code\": 0,\n\"description\": \"operation has been success\"\n},\n\"data\": {}\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "result": {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "success"
                        },
                        "code": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "description": {
                          "type": "string",
                          "example": "operation has been success"
                        }
                      }
                    },
                    "data": {
                      "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
  }
}
```