---
title: Create a subscription
slug: api/create-a-subscription
docTags: 
createdAt: 2026-08-27T03:37:36.255Z
---

{
  "id": "2lxWMPDcm6OZftJLSw5Wy",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://sand-api.monoova.com/au/core/notification-v1/Subscription",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/au/core/notification-v1/Subscription",
        "description": "Sandbox URL"
      },
      {
        "url": "https://api.monoova.com/au/core/notification-v1/Subscription",
        "description": "Production URL"
      }
    ],
    "name": "Create a subscription",
    "description": "Creates a new webhook subscription.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "<p><strong>Required.</strong> Subscription definition. All fields are pre-filled with valid example values; replace them with your own before sending.</p>",
          "customType": "SubscriptionDetailCreateDto",
          "schema": [
            {
              "name": "subscriptionName",
              "kind": "required",
              "type": "string",
              "description": "<p><strong>Required.</strong> User-Defined name, to make the purpose or owner clear. Name provided by customers only. 1 to 36 characters, limited to letters, digits, underscore and hyphen.</p>",
              "example": "Payments-Prod-Webhook",
              "default": "Payments-Prod-Webhook",
              "pattern": "^[-\\w]{1,36}$"
            },
            {
              "name": "eventName",
              "kind": "required",
              "type": "string<PaymentAgreementNotification | PaymentInstructionNotification | CreditCardPaymentNotification | CreditCardRefundNotification | AsyncJobResultNotification>",
              "description": "<p><strong>Required.</strong> The event we are subscribing to. Must be one of the listed enum values.</p>",
              "example": "PaymentInstructionNotification",
              "default": "PaymentInstructionNotification",
              "enum": [
                "PaymentAgreementNotification",
                "PaymentInstructionNotification",
                "CreditCardPaymentNotification",
                "CreditCardRefundNotification",
                "AsyncJobResultNotification"
              ],
              "pattern": "^(PaymentAgreementNotification|PaymentInstructionNotification|CreditCardPaymentNotification|CreditCardRefundNotification|AsyncJobResultNotification)$"
            },
            {
              "name": "webHookDetail",
              "kind": "optional",
              "type": "object",
              "description": "<p><strong>Required.</strong> Webhook delivery settings for this subscription. Webhook is the only delivery channel available, so a subscription created without this object will not deliver anything.</p>\n<p>Pattern: <code>callBackUrl</code> must satisfy <code>^https?:\\/\\/[^\\s]+$</code>.</p>",
              "example": "{\"callBackUrl\":\"https://api.yourcompany.com/monoova/webhooks\",\"securityToken\":\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\"}",
              "default": {
                "callBackUrl": "https://api.yourcompany.com/monoova/webhooks",
                "securityToken": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
              },
              "schema": [
                {
                  "name": "callBackUrl",
                  "kind": "required",
                  "type": "string",
                  "description": "<p><strong>Required.</strong> URL of your server. Must be a well formed URI, reachable from the public internet, and able to accept an HTTPS POST carrying the notification payload.</p>",
                  "example": "https://api.yourcompany.com/monoova/webhooks",
                  "default": "https://api.yourcompany.com/monoova/webhooks",
                  "pattern": "^https?:\\/\\/[^\\s]+$"
                },
                {
                  "name": "securityToken",
                  "kind": "optional",
                  "type": "string",
                  "nullable": true,
                  "description": "<p><strong>Optional.</strong> This token will be sent back with the callback in Authorization header. When creating the token, both 'type' and 'credentials' are required, for example <code>Bearer &#x3C;credentials></code>.</p>",
                  "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
                  "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
                  "pattern": "^[A-Za-z][A-Za-z0-9-]{0,50} .{1,4000}$"
                }
              ]
            },
            {
              "name": "isActive",
              "kind": "required",
              "type": "boolean",
              "description": "<p><strong>Required.</strong> Controls whether the subscription delivers notifications. Send <code>true</code> to activate it, or <code>false</code> to keep it registered but suspended.</p>\n<p>Pattern: ^(true|false)$</p>",
              "example": true,
              "default": true
            }
          ],
          "modelRef": "#/components/schemas/SubscriptionDetailCreateDto",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "BearerAuth",
          "name": "BearerAuth",
          "kind": "optional",
          "type": "http",
          "description": "<p><strong>Required.</strong> Bearer JWT issued by Monoova. Send it on every request as <code>Authorization: Bearer &#x3C;token></code>.</p>\n<p>Pattern: ^[A-Za-z0-9-<em>]+.[A-Za-z0-9-</em>]+.[A-Za-z0-9-_]+$</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "SubscriptionUpdateResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Unique id for logging, generated by Monoova for this request. Quote this value when raising a support ticket so the request can be traced end to end.</p>",
                "example": "0HN7GKQ2E9V3J:00000001",
                "default": "0HN7GKQ2E9V3J:00000001",
                "pattern": "^[-\\w:.]{1,128}$"
              },
              {
                "name": "subscriptionId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Monoova generated Guid to uniquely identify the subscription. Store this value; it is required by the <code>/Subscription/{subscriptionId}</code> endpoints.</p>",
                "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
                "default": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
                "pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"
              }
            ],
            "modelRef": "#/components/schemas/SubscriptionUpdateResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad Request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Unique id for logging, generated by Monoova for this request. Quote this value when raising a support ticket so the request can be traced end to end.</p>",
                "example": "0HN7GKQ2E9V3J:00000001",
                "default": "0HN7GKQ2E9V3J:00000001",
                "pattern": "^[-\\w:.]{1,128}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Collection of the individual errors that caused the request to fail. Returned as <code>null</code> when the request succeeded.</p>\n<p>Pattern: Each item must satisfy <code>^NOS_[A-Z_]+$</code> on its <code>errorCode</code> field.</p>",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<NOS_REQ_BODY_INVALID | NOS_VALIDATION_ERROR | NOS_ACCTID_REQUIRED | NOS_TRACEID_REQUIRED | NOS_HEADER_REQUIRED | NOS_REQUEST_EMPTY | NOS_SUBID_REQUIRED | NOS_SUBID_INVALID | NOS_SUBNAME_REQUIRED | NOS_SUBNAME_INVALID | NOS_ISACTIVE_REQUIRED | NOS_EVTID_REQUIRED | NOS_EVTNAME_REQUIRED | NOS_EVTNAME_DISABLED | NOS_EVTNAME_INVALID | NOS_AUTHORIZATIONTYPE_INVALID | NOS_WEBDTL_REQUIRED | NOS_URL_REQUIRED | NOS_URL_INVALID | NOS_SECURITYTOKEN_INVALID | NOS_EML_REQUIRED | NOS_EML_INVALID | NOS_EML_LIST_SIZE | NOS_STS_INVALID | NOS_PGSIZ_INVALID | NOS_PGNUM_INVALID | NOS_STARTDATE_INVALID | NOS_ENDDATE_INVALID | NOS_DATERANGE_INVALID | NOS_DATERANGE_SIZE | NOS_EVENT_NOT_FOUND_ERROR | NOS_SUB_NOT_FOUND_ERROR | NOS_DUP_SUB_CRT_ERROR | NOS_DUP_SUB_UPD_ERROR | NOS_DEL_SUB_ERROR | NOS_UPD_SUB_ERROR | NOS_UNEXPECTED_ERROR | NOS_RETRY_NEEDED_ERROR | NOS_MESSAGING_FAILURE_ERROR | NOS_FX_PAYLOAD_REQUIRED | NOS_FX_PAYLOAD_INVALID | NOS_FX_PAYLOAD_SIGNATURE_ERROR | NOS_FX_SIGNATURE_REQUIRED | NOS_FX_PAYLOAD_CUSTOMERID_ERROR | NOS_KYB_FUNCTION_REQUIRED | NOS_KYB_CLIENTID_REQUIRED | NOS_KYB_FUNCTION_INVALID | NOS_KYB_PAYLOAD_INVALID>",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> Monoova error code identifying the specific validation or processing failure. Present only in error responses.</p>",
                    "example": "NOS_VALIDATION_ERROR",
                    "default": "NOS_VALIDATION_ERROR",
                    "enum": [
                      "NOS_REQ_BODY_INVALID",
                      "NOS_VALIDATION_ERROR",
                      "NOS_ACCTID_REQUIRED",
                      "NOS_TRACEID_REQUIRED",
                      "NOS_HEADER_REQUIRED",
                      "NOS_REQUEST_EMPTY",
                      "NOS_SUBID_REQUIRED",
                      "NOS_SUBID_INVALID",
                      "NOS_SUBNAME_REQUIRED",
                      "NOS_SUBNAME_INVALID",
                      "NOS_ISACTIVE_REQUIRED",
                      "NOS_EVTID_REQUIRED",
                      "NOS_EVTNAME_REQUIRED",
                      "NOS_EVTNAME_DISABLED",
                      "NOS_EVTNAME_INVALID",
                      "NOS_AUTHORIZATIONTYPE_INVALID",
                      "NOS_WEBDTL_REQUIRED",
                      "NOS_URL_REQUIRED",
                      "NOS_URL_INVALID",
                      "NOS_SECURITYTOKEN_INVALID",
                      "NOS_EML_REQUIRED",
                      "NOS_EML_INVALID",
                      "NOS_EML_LIST_SIZE",
                      "NOS_STS_INVALID",
                      "NOS_PGSIZ_INVALID",
                      "NOS_PGNUM_INVALID",
                      "NOS_STARTDATE_INVALID",
                      "NOS_ENDDATE_INVALID",
                      "NOS_DATERANGE_INVALID",
                      "NOS_DATERANGE_SIZE",
                      "NOS_EVENT_NOT_FOUND_ERROR",
                      "NOS_SUB_NOT_FOUND_ERROR",
                      "NOS_DUP_SUB_CRT_ERROR",
                      "NOS_DUP_SUB_UPD_ERROR",
                      "NOS_DEL_SUB_ERROR",
                      "NOS_UPD_SUB_ERROR",
                      "NOS_UNEXPECTED_ERROR",
                      "NOS_RETRY_NEEDED_ERROR",
                      "NOS_MESSAGING_FAILURE_ERROR",
                      "NOS_FX_PAYLOAD_REQUIRED",
                      "NOS_FX_PAYLOAD_INVALID",
                      "NOS_FX_PAYLOAD_SIGNATURE_ERROR",
                      "NOS_FX_SIGNATURE_REQUIRED",
                      "NOS_FX_PAYLOAD_CUSTOMERID_ERROR",
                      "NOS_KYB_FUNCTION_REQUIRED",
                      "NOS_KYB_CLIENTID_REQUIRED",
                      "NOS_KYB_FUNCTION_INVALID",
                      "NOS_KYB_PAYLOAD_INVALID"
                    ],
                    "pattern": "^NOS_[A-Z_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> More detailed description of the specific error which may include information from the specific request.</p>",
                    "example": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "default": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "pattern": "^.{1,1000}$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Unique id for logging, generated by Monoova for this request. Quote this value when raising a support ticket so the request can be traced end to end.</p>",
                "example": "0HN7GKQ2E9V3J:00000001",
                "default": "0HN7GKQ2E9V3J:00000001",
                "pattern": "^[-\\w:.]{1,128}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Collection of the individual errors that caused the request to fail. Returned as <code>null</code> when the request succeeded.</p>\n<p>Pattern: Each item must satisfy <code>^NOS_[A-Z_]+$</code> on its <code>errorCode</code> field.</p>",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<NOS_REQ_BODY_INVALID | NOS_VALIDATION_ERROR | NOS_ACCTID_REQUIRED | NOS_TRACEID_REQUIRED | NOS_HEADER_REQUIRED | NOS_REQUEST_EMPTY | NOS_SUBID_REQUIRED | NOS_SUBID_INVALID | NOS_SUBNAME_REQUIRED | NOS_SUBNAME_INVALID | NOS_ISACTIVE_REQUIRED | NOS_EVTID_REQUIRED | NOS_EVTNAME_REQUIRED | NOS_EVTNAME_DISABLED | NOS_EVTNAME_INVALID | NOS_AUTHORIZATIONTYPE_INVALID | NOS_WEBDTL_REQUIRED | NOS_URL_REQUIRED | NOS_URL_INVALID | NOS_SECURITYTOKEN_INVALID | NOS_EML_REQUIRED | NOS_EML_INVALID | NOS_EML_LIST_SIZE | NOS_STS_INVALID | NOS_PGSIZ_INVALID | NOS_PGNUM_INVALID | NOS_STARTDATE_INVALID | NOS_ENDDATE_INVALID | NOS_DATERANGE_INVALID | NOS_DATERANGE_SIZE | NOS_EVENT_NOT_FOUND_ERROR | NOS_SUB_NOT_FOUND_ERROR | NOS_DUP_SUB_CRT_ERROR | NOS_DUP_SUB_UPD_ERROR | NOS_DEL_SUB_ERROR | NOS_UPD_SUB_ERROR | NOS_UNEXPECTED_ERROR | NOS_RETRY_NEEDED_ERROR | NOS_MESSAGING_FAILURE_ERROR | NOS_FX_PAYLOAD_REQUIRED | NOS_FX_PAYLOAD_INVALID | NOS_FX_PAYLOAD_SIGNATURE_ERROR | NOS_FX_SIGNATURE_REQUIRED | NOS_FX_PAYLOAD_CUSTOMERID_ERROR | NOS_KYB_FUNCTION_REQUIRED | NOS_KYB_CLIENTID_REQUIRED | NOS_KYB_FUNCTION_INVALID | NOS_KYB_PAYLOAD_INVALID>",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> Monoova error code identifying the specific validation or processing failure. Present only in error responses.</p>",
                    "example": "NOS_VALIDATION_ERROR",
                    "default": "NOS_VALIDATION_ERROR",
                    "enum": [
                      "NOS_REQ_BODY_INVALID",
                      "NOS_VALIDATION_ERROR",
                      "NOS_ACCTID_REQUIRED",
                      "NOS_TRACEID_REQUIRED",
                      "NOS_HEADER_REQUIRED",
                      "NOS_REQUEST_EMPTY",
                      "NOS_SUBID_REQUIRED",
                      "NOS_SUBID_INVALID",
                      "NOS_SUBNAME_REQUIRED",
                      "NOS_SUBNAME_INVALID",
                      "NOS_ISACTIVE_REQUIRED",
                      "NOS_EVTID_REQUIRED",
                      "NOS_EVTNAME_REQUIRED",
                      "NOS_EVTNAME_DISABLED",
                      "NOS_EVTNAME_INVALID",
                      "NOS_AUTHORIZATIONTYPE_INVALID",
                      "NOS_WEBDTL_REQUIRED",
                      "NOS_URL_REQUIRED",
                      "NOS_URL_INVALID",
                      "NOS_SECURITYTOKEN_INVALID",
                      "NOS_EML_REQUIRED",
                      "NOS_EML_INVALID",
                      "NOS_EML_LIST_SIZE",
                      "NOS_STS_INVALID",
                      "NOS_PGSIZ_INVALID",
                      "NOS_PGNUM_INVALID",
                      "NOS_STARTDATE_INVALID",
                      "NOS_ENDDATE_INVALID",
                      "NOS_DATERANGE_INVALID",
                      "NOS_DATERANGE_SIZE",
                      "NOS_EVENT_NOT_FOUND_ERROR",
                      "NOS_SUB_NOT_FOUND_ERROR",
                      "NOS_DUP_SUB_CRT_ERROR",
                      "NOS_DUP_SUB_UPD_ERROR",
                      "NOS_DEL_SUB_ERROR",
                      "NOS_UPD_SUB_ERROR",
                      "NOS_UNEXPECTED_ERROR",
                      "NOS_RETRY_NEEDED_ERROR",
                      "NOS_MESSAGING_FAILURE_ERROR",
                      "NOS_FX_PAYLOAD_REQUIRED",
                      "NOS_FX_PAYLOAD_INVALID",
                      "NOS_FX_PAYLOAD_SIGNATURE_ERROR",
                      "NOS_FX_SIGNATURE_REQUIRED",
                      "NOS_FX_PAYLOAD_CUSTOMERID_ERROR",
                      "NOS_KYB_FUNCTION_REQUIRED",
                      "NOS_KYB_CLIENTID_REQUIRED",
                      "NOS_KYB_FUNCTION_INVALID",
                      "NOS_KYB_PAYLOAD_INVALID"
                    ],
                    "pattern": "^NOS_[A-Z_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> More detailed description of the specific error which may include information from the specific request.</p>",
                    "example": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "default": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "pattern": "^.{1,1000}$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Forbidden",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Unique id for logging, generated by Monoova for this request. Quote this value when raising a support ticket so the request can be traced end to end.</p>",
                "example": "0HN7GKQ2E9V3J:00000001",
                "default": "0HN7GKQ2E9V3J:00000001",
                "pattern": "^[-\\w:.]{1,128}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Collection of the individual errors that caused the request to fail. Returned as <code>null</code> when the request succeeded.</p>\n<p>Pattern: Each item must satisfy <code>^NOS_[A-Z_]+$</code> on its <code>errorCode</code> field.</p>",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<NOS_REQ_BODY_INVALID | NOS_VALIDATION_ERROR | NOS_ACCTID_REQUIRED | NOS_TRACEID_REQUIRED | NOS_HEADER_REQUIRED | NOS_REQUEST_EMPTY | NOS_SUBID_REQUIRED | NOS_SUBID_INVALID | NOS_SUBNAME_REQUIRED | NOS_SUBNAME_INVALID | NOS_ISACTIVE_REQUIRED | NOS_EVTID_REQUIRED | NOS_EVTNAME_REQUIRED | NOS_EVTNAME_DISABLED | NOS_EVTNAME_INVALID | NOS_AUTHORIZATIONTYPE_INVALID | NOS_WEBDTL_REQUIRED | NOS_URL_REQUIRED | NOS_URL_INVALID | NOS_SECURITYTOKEN_INVALID | NOS_EML_REQUIRED | NOS_EML_INVALID | NOS_EML_LIST_SIZE | NOS_STS_INVALID | NOS_PGSIZ_INVALID | NOS_PGNUM_INVALID | NOS_STARTDATE_INVALID | NOS_ENDDATE_INVALID | NOS_DATERANGE_INVALID | NOS_DATERANGE_SIZE | NOS_EVENT_NOT_FOUND_ERROR | NOS_SUB_NOT_FOUND_ERROR | NOS_DUP_SUB_CRT_ERROR | NOS_DUP_SUB_UPD_ERROR | NOS_DEL_SUB_ERROR | NOS_UPD_SUB_ERROR | NOS_UNEXPECTED_ERROR | NOS_RETRY_NEEDED_ERROR | NOS_MESSAGING_FAILURE_ERROR | NOS_FX_PAYLOAD_REQUIRED | NOS_FX_PAYLOAD_INVALID | NOS_FX_PAYLOAD_SIGNATURE_ERROR | NOS_FX_SIGNATURE_REQUIRED | NOS_FX_PAYLOAD_CUSTOMERID_ERROR | NOS_KYB_FUNCTION_REQUIRED | NOS_KYB_CLIENTID_REQUIRED | NOS_KYB_FUNCTION_INVALID | NOS_KYB_PAYLOAD_INVALID>",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> Monoova error code identifying the specific validation or processing failure. Present only in error responses.</p>",
                    "example": "NOS_VALIDATION_ERROR",
                    "default": "NOS_VALIDATION_ERROR",
                    "enum": [
                      "NOS_REQ_BODY_INVALID",
                      "NOS_VALIDATION_ERROR",
                      "NOS_ACCTID_REQUIRED",
                      "NOS_TRACEID_REQUIRED",
                      "NOS_HEADER_REQUIRED",
                      "NOS_REQUEST_EMPTY",
                      "NOS_SUBID_REQUIRED",
                      "NOS_SUBID_INVALID",
                      "NOS_SUBNAME_REQUIRED",
                      "NOS_SUBNAME_INVALID",
                      "NOS_ISACTIVE_REQUIRED",
                      "NOS_EVTID_REQUIRED",
                      "NOS_EVTNAME_REQUIRED",
                      "NOS_EVTNAME_DISABLED",
                      "NOS_EVTNAME_INVALID",
                      "NOS_AUTHORIZATIONTYPE_INVALID",
                      "NOS_WEBDTL_REQUIRED",
                      "NOS_URL_REQUIRED",
                      "NOS_URL_INVALID",
                      "NOS_SECURITYTOKEN_INVALID",
                      "NOS_EML_REQUIRED",
                      "NOS_EML_INVALID",
                      "NOS_EML_LIST_SIZE",
                      "NOS_STS_INVALID",
                      "NOS_PGSIZ_INVALID",
                      "NOS_PGNUM_INVALID",
                      "NOS_STARTDATE_INVALID",
                      "NOS_ENDDATE_INVALID",
                      "NOS_DATERANGE_INVALID",
                      "NOS_DATERANGE_SIZE",
                      "NOS_EVENT_NOT_FOUND_ERROR",
                      "NOS_SUB_NOT_FOUND_ERROR",
                      "NOS_DUP_SUB_CRT_ERROR",
                      "NOS_DUP_SUB_UPD_ERROR",
                      "NOS_DEL_SUB_ERROR",
                      "NOS_UPD_SUB_ERROR",
                      "NOS_UNEXPECTED_ERROR",
                      "NOS_RETRY_NEEDED_ERROR",
                      "NOS_MESSAGING_FAILURE_ERROR",
                      "NOS_FX_PAYLOAD_REQUIRED",
                      "NOS_FX_PAYLOAD_INVALID",
                      "NOS_FX_PAYLOAD_SIGNATURE_ERROR",
                      "NOS_FX_SIGNATURE_REQUIRED",
                      "NOS_FX_PAYLOAD_CUSTOMERID_ERROR",
                      "NOS_KYB_FUNCTION_REQUIRED",
                      "NOS_KYB_CLIENTID_REQUIRED",
                      "NOS_KYB_FUNCTION_INVALID",
                      "NOS_KYB_PAYLOAD_INVALID"
                    ],
                    "pattern": "^NOS_[A-Z_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> More detailed description of the specific error which may include information from the specific request.</p>",
                    "example": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "default": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "pattern": "^.{1,1000}$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not Found",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "traceId",
                "kind": "optional",
                "type": "string",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Unique id for logging, generated by Monoova for this request. Quote this value when raising a support ticket so the request can be traced end to end.</p>",
                "example": "0HN7GKQ2E9V3J:00000001",
                "default": "0HN7GKQ2E9V3J:00000001",
                "pattern": "^[-\\w:.]{1,128}$"
              },
              {
                "name": "errors",
                "kind": "optional",
                "type": "array",
                "nullable": true,
                "description": "<p><strong>Optional.</strong> Collection of the individual errors that caused the request to fail. Returned as <code>null</code> when the request succeeded.</p>\n<p>Pattern: Each item must satisfy <code>^NOS_[A-Z_]+$</code> on its <code>errorCode</code> field.</p>",
                "modelRef": "#/components/schemas/ErrorDto",
                "customType": "ErrorDto[]",
                "schema": [
                  {
                    "name": "errorCode",
                    "kind": "optional",
                    "type": "string<NOS_REQ_BODY_INVALID | NOS_VALIDATION_ERROR | NOS_ACCTID_REQUIRED | NOS_TRACEID_REQUIRED | NOS_HEADER_REQUIRED | NOS_REQUEST_EMPTY | NOS_SUBID_REQUIRED | NOS_SUBID_INVALID | NOS_SUBNAME_REQUIRED | NOS_SUBNAME_INVALID | NOS_ISACTIVE_REQUIRED | NOS_EVTID_REQUIRED | NOS_EVTNAME_REQUIRED | NOS_EVTNAME_DISABLED | NOS_EVTNAME_INVALID | NOS_AUTHORIZATIONTYPE_INVALID | NOS_WEBDTL_REQUIRED | NOS_URL_REQUIRED | NOS_URL_INVALID | NOS_SECURITYTOKEN_INVALID | NOS_EML_REQUIRED | NOS_EML_INVALID | NOS_EML_LIST_SIZE | NOS_STS_INVALID | NOS_PGSIZ_INVALID | NOS_PGNUM_INVALID | NOS_STARTDATE_INVALID | NOS_ENDDATE_INVALID | NOS_DATERANGE_INVALID | NOS_DATERANGE_SIZE | NOS_EVENT_NOT_FOUND_ERROR | NOS_SUB_NOT_FOUND_ERROR | NOS_DUP_SUB_CRT_ERROR | NOS_DUP_SUB_UPD_ERROR | NOS_DEL_SUB_ERROR | NOS_UPD_SUB_ERROR | NOS_UNEXPECTED_ERROR | NOS_RETRY_NEEDED_ERROR | NOS_MESSAGING_FAILURE_ERROR | NOS_FX_PAYLOAD_REQUIRED | NOS_FX_PAYLOAD_INVALID | NOS_FX_PAYLOAD_SIGNATURE_ERROR | NOS_FX_SIGNATURE_REQUIRED | NOS_FX_PAYLOAD_CUSTOMERID_ERROR | NOS_KYB_FUNCTION_REQUIRED | NOS_KYB_CLIENTID_REQUIRED | NOS_KYB_FUNCTION_INVALID | NOS_KYB_PAYLOAD_INVALID>",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> Monoova error code identifying the specific validation or processing failure. Present only in error responses.</p>",
                    "example": "NOS_VALIDATION_ERROR",
                    "default": "NOS_VALIDATION_ERROR",
                    "enum": [
                      "NOS_REQ_BODY_INVALID",
                      "NOS_VALIDATION_ERROR",
                      "NOS_ACCTID_REQUIRED",
                      "NOS_TRACEID_REQUIRED",
                      "NOS_HEADER_REQUIRED",
                      "NOS_REQUEST_EMPTY",
                      "NOS_SUBID_REQUIRED",
                      "NOS_SUBID_INVALID",
                      "NOS_SUBNAME_REQUIRED",
                      "NOS_SUBNAME_INVALID",
                      "NOS_ISACTIVE_REQUIRED",
                      "NOS_EVTID_REQUIRED",
                      "NOS_EVTNAME_REQUIRED",
                      "NOS_EVTNAME_DISABLED",
                      "NOS_EVTNAME_INVALID",
                      "NOS_AUTHORIZATIONTYPE_INVALID",
                      "NOS_WEBDTL_REQUIRED",
                      "NOS_URL_REQUIRED",
                      "NOS_URL_INVALID",
                      "NOS_SECURITYTOKEN_INVALID",
                      "NOS_EML_REQUIRED",
                      "NOS_EML_INVALID",
                      "NOS_EML_LIST_SIZE",
                      "NOS_STS_INVALID",
                      "NOS_PGSIZ_INVALID",
                      "NOS_PGNUM_INVALID",
                      "NOS_STARTDATE_INVALID",
                      "NOS_ENDDATE_INVALID",
                      "NOS_DATERANGE_INVALID",
                      "NOS_DATERANGE_SIZE",
                      "NOS_EVENT_NOT_FOUND_ERROR",
                      "NOS_SUB_NOT_FOUND_ERROR",
                      "NOS_DUP_SUB_CRT_ERROR",
                      "NOS_DUP_SUB_UPD_ERROR",
                      "NOS_DEL_SUB_ERROR",
                      "NOS_UPD_SUB_ERROR",
                      "NOS_UNEXPECTED_ERROR",
                      "NOS_RETRY_NEEDED_ERROR",
                      "NOS_MESSAGING_FAILURE_ERROR",
                      "NOS_FX_PAYLOAD_REQUIRED",
                      "NOS_FX_PAYLOAD_INVALID",
                      "NOS_FX_PAYLOAD_SIGNATURE_ERROR",
                      "NOS_FX_SIGNATURE_REQUIRED",
                      "NOS_FX_PAYLOAD_CUSTOMERID_ERROR",
                      "NOS_KYB_FUNCTION_REQUIRED",
                      "NOS_KYB_CLIENTID_REQUIRED",
                      "NOS_KYB_FUNCTION_INVALID",
                      "NOS_KYB_PAYLOAD_INVALID"
                    ],
                    "pattern": "^NOS_[A-Z_]+$"
                  },
                  {
                    "name": "errorMessage",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p><strong>Optional.</strong> More detailed description of the specific error which may include information from the specific request.</p>",
                    "example": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "default": "subscriptionName must match the pattern ^[-\\w]{1,36}$.",
                    "pattern": "^.{1,1000}$"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal Server Error",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "EKgbQkzUm42YcIupSDAlX",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://sand-api.monoova.com/au/core/notification-v1/Subscription \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"subscriptionName\": \"Payments-Prod-Webhook\",\n     \"eventName\": \"PaymentInstructionNotification\",\n     \"webHookDetail\": {\n     \"callBackUrl\": \"https://api.yourcompany.com/monoova/webhooks\",\n     \"securityToken\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\"\n     },\n     \"isActive\": true\n     }'"
        },
        {
          "id": "0Q9ep_6Nty0JX4mKM4O1r",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"subscriptionName\": \"Payments-Prod-Webhook\",\n   \"eventName\": \"PaymentInstructionNotification\",\n   \"webHookDetail\": {\n      \"callBackUrl\": \"https://api.yourcompany.com/monoova/webhooks\",\n      \"securityToken\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\"\n   },\n   \"isActive\": true\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/core/notification-v1/Subscription\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "rfkTQkmqMQ540XDbG8Cmj",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/au/core/notification-v1/Subscription\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"subscriptionName\": \"Payments-Prod-Webhook\",\n   \"eventName\": \"PaymentInstructionNotification\",\n   \"webHookDetail\": {\n      \"callBackUrl\": \"https://api.yourcompany.com/monoova/webhooks\",\n      \"securityToken\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\"\n   },\n   \"isActive\": true\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "AN0FCZw_vB2RE3yWoKlcE",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/au/core/notification-v1/Subscription\"\n\npayload = json.dumps({\n   \"subscriptionName\": \"Payments-Prod-Webhook\",\n   \"eventName\": \"PaymentInstructionNotification\",\n   \"webHookDetail\": {\n      \"callBackUrl\": \"https://api.yourcompany.com/monoova/webhooks\",\n      \"securityToken\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\"\n   },\n   \"isActive\": True\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "EKgbQkzUm42YcIupSDAlX"
    },
    "results": {
      "languages": [
        {
          "id": "_kyL6ZssRgb1Xp4RFiVYq",
          "language": "200",
          "code": "// OK\n{\n  \"traceId\": \"0HN7GKQ2E9V3J:00000001\",\n  \"subscriptionId\": \"3f2504e0-4f89-11d3-9a0c-0305e82c3301\"\n}"
        },
        {
          "id": "WHCY6phAk65hmpP4uvZ4v",
          "language": "400",
          "code": "// Bad Request\n{\n  \"traceId\": \"0HN7GKQ2E9V3J:00000001\",\n  \"errors\": [\n    {\n      \"errorCode\": \"NOS_VALIDATION_ERROR\",\n      \"errorMessage\": \"subscriptionName must match the pattern ^[-\\\\w]{1,36}$.\"\n    }\n  ]\n}"
        },
        {
          "id": "p2V4DLSl82lDsLfoeI71Y",
          "language": "401",
          "code": "// Unauthorized\n{\n  \"traceId\": \"0HN7GKQ2E9V3J:00000001\",\n  \"errors\": [\n    {\n      \"errorCode\": \"NOS_VALIDATION_ERROR\",\n      \"errorMessage\": \"subscriptionName must match the pattern ^[-\\\\w]{1,36}$.\"\n    }\n  ]\n}"
        },
        {
          "id": "EPuAeh1ToHfHiVsF-JqNJ",
          "language": "403",
          "code": "// Forbidden\n{\n  \"traceId\": \"0HN7GKQ2E9V3J:00000001\",\n  \"errors\": [\n    {\n      \"errorCode\": \"NOS_VALIDATION_ERROR\",\n      \"errorMessage\": \"subscriptionName must match the pattern ^[-\\\\w]{1,36}$.\"\n    }\n  ]\n}"
        },
        {
          "id": "_49tnQLl_CwWZjI9DOI9T",
          "language": "404",
          "code": "// Not Found\n{\n  \"traceId\": \"0HN7GKQ2E9V3J:00000001\",\n  \"errors\": [\n    {\n      \"errorCode\": \"NOS_VALIDATION_ERROR\",\n      \"errorMessage\": \"subscriptionName must match the pattern ^[-\\\\w]{1,36}$.\"\n    }\n  ]\n}"
        },
        {
          "id": "WA7cKzUPTsq60Dw6XsPm7",
          "language": "500",
          "code": "// Internal Server Error\n"
        }
      ],
      "selectedLanguageId": "_kyL6ZssRgb1Xp4RFiVYq"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}