---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Send a global notification

Sends a notification via SMS, email, or other channels. Supports a TEMPLATE type using Handlebars templates configured via properties.

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "Avp": {
        "description": "An attribute/value pair for providing weakly typed data on various messages",
        "type": "object",
        "required": [
          "att",
          "val"
        ],
        "properties": {
          "att": {
            "type": "string",
            "pattern": "\\S"
          },
          "val": {
            "type": "string"
          }
        }
      },
      "DeviceMessage": {
        "type": "object",
        "properties": {
          "avps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Avp"
            }
          },
          "body": {
            "type": "string"
          },
          "imageUrl": {
            "type": "string"
          },
          "priority": {
            "$ref": "#/components/schemas/EclipseMessagePriority"
          },
          "timeToLive": {
            "type": "integer",
            "format": "int32",
            "description": "How long (in seconds) the message should be kept in FCM storage if the device is offline."
          },
          "title": {
            "type": "string"
          }
        }
      },
      "EclipseMessagePriority": {
        "type": "string",
        "enum": [
          "HIGH",
          "NORMAL"
        ]
      },
      "EclipseNotification": {
        "description": "Allow to send notification",
        "type": "object",
        "properties": {
          "cardBin": {
            "type": "string"
          },
          "customerId": {
            "type": "integer",
            "format": "int64"
          },
          "data": {
            "type": "string",
            "description": "Data must be sent in JSON format, Data is bound with Mustache template(templateId) so need to send the same key that is used in a template.For email attachment use key 'mediaType' & 'base64EncodedAttachment' in data JSON format",
            "minLength": 3
          },
          "deviceMessage": {
            "$ref": "#/components/schemas/DeviceMessage"
          },
          "eventType": {
            "type": "string"
          },
          "ruleMatch": {
            "type": "string"
          },
          "templateId": {
            "type": "string",
            "description": "Mustache template Id for notification. The eclipse will look templateId in the property if templateId is found then it will send SMS else return an error. Need to set templateId in this format in property mustache.sms.\\<tenantId\\>.\\<templateId\\> i.e If tenants set property like mustache.sms.2.auth then they can pass either mustache.sms.2.auth or auth as templateId value.",
            "minLength": 3,
            "maxLength": 100
          },
          "tokenId": {
            "type": "integer",
            "format": "int64"
          },
          "type": {
            "$ref": "#/components/schemas/EclipseNotificationType",
            "description": "Type of notification to be sent. If not provided in the request, the system will determine the type based on customer ID, wallet ID, or tenant ID. If none match, an SMS notification will be sent by default.",
            "type": "string"
          },
          "walletId": {
            "type": "integer",
            "format": "int64"
          }
        },
        "required": [
          "data"
        ]
      },
      "EclipseNotificationType": {
        "type": "string",
        "enum": [
          "EMAIL",
          "PUSH",
          "SMS",
          "TEMPLATE"
        ]
      },
      "ExceptionData": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "environment": {
            "type": "string"
          },
          "info": {
            "type": "object",
            "additionalProperties": {}
          },
          "severity": {
            "$ref": "#/components/schemas/ExceptionSeverity"
          },
          "spanId": {
            "type": "string"
          },
          "stackTrace": {
            "type": "string"
          },
          "traceId": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/ExceptionType"
          }
        }
      },
      "ExceptionSeverity": {
        "type": "string",
        "enum": [
          "CRITICAL",
          "HIGH",
          "INFO",
          "LOW",
          "MEDIUM"
        ]
      },
      "ExceptionType": {
        "type": "string",
        "enum": [
          "BUSINESS",
          "SYSTEM"
        ]
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "z) Global Functionality",
      "description": "For internal use only. Functionality that is not specific to a tenant"
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/global/notifications": {
      "post": {
        "summary": "Send a global notification",
        "description": "Sends a notification via SMS, email, or other channels. Supports a TEMPLATE type using Handlebars templates configured via properties.",
        "tags": [
          "z) Global Functionality"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EclipseNotification"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Bad Request"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ],
        "parameters": []
      }
    }
  }
}
```