Create Subscription

post

https://api.sb.moneris.io/subscriptions

This operation is used to create a Subscription.

Webhooks

Webhook Definition Details

application/json

  <div class="tab-content" style="display: block;">
    <type-definition>
      <h4 class="text-truncate flex-grow">Webhook Request Body</h4>
      <p>
      <p>This is the base definition for all event messages. It contains the common properties that are shared across all events.</p>
      </p>
      <div role="table" class="table-preset table-preset-schema" id="webhookRequestTable">
        <div class="d-contents" role="rowgroup">
          <div class="d-contents" role="row">
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>
                Name</span>
            </div>
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>
                Required</span>
            </div>
            <div role="columnheader" class="table-preset-head text-truncate">
              <span>Additional
                Info</span>
            </div>
            <div role="columnheader" class="table-preset-head">
              <span>
                Description</span>
            </div>
          </div>
        </div>
        <div class="d-contents" role="rowgroup">
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="eventId">
              eventId</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Identifier of the triggered
                event. Can be used
                as an idempotency key to
                detect duplicates.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="eventType">
              eventType</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>This is a
                list of all the types of
                events we currently
                send.</p>
              <ul>
                <li>RECURRING_PAYMENT_CONFIRMED: A payment transaction has been executed.</li>
              </ul>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="occuredAt">
              occuredAt</div>
            <div role="cell">
              true</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                date-time</a>
            </div>
            <div role="cell">
              <p>the timestamp of when the event occurred (not
                necessarily the same of when it was
                delivered)</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="apiVersion">
              apiVersion</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>The Moneris API Version used to
                populate the event
                payload.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="objectId">
              objectId</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Used to
                identify API resources which
                may be required for
                future follow-on
                transactions; i.e. Refunds,
                Corrections,
                Completions, Reversals,
                etc.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="href">
              href</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Uniform
                resource locator to retrieve
                resource
                details.</p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="correlationId">
              correlationId</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace" title="string">
                string</a>
            </div>
            <div role="cell">
              <p>Correlation Id transmitted during the
                original request.
                This is useful to correlate between
                multiple events corresponding to same
                flow. </p>
            </div>
          </div>
          <div class="d-contents" role="row">
            <div role="cell" class="text-truncate" title="data">
              data</div>
            <div role="cell">
              false</div>
            <div role="cell" class="text-truncate">
              <a class="text-monospace"
                href="/api-details#api=moneris-api-2025-02-20-preview&operation=createPayments" title="payment">
                payment</a>
            </div>
            <div role="cell">
              <p>The Payment data associated with the
                event.</p>
            </div>
          </div>
        </div>
      </div>
      <code-snippet id="webhookRequestDefinition" style="display: none;">
        <h4></h4>
        <div></div>
        <div class="flex code-snippet code-snippet-bordered">
          <div class="code-snippet-heading">
            <span class="code-snippet-title">json</span>
            <button class="code-snippet-command" aria-label="Copy to clipboard">
              <i class="icon-emb icon-emb-duplicate"></i>
              <span>Copy</span>
            </button>
          </div>
        </div>
        <pre>

{
"title": "webhookRequest",
"required": [
"eventId",
"eventType",
"occuredAt",
],
"type": "object",
"properties": {
"eventId": {
"type": "string"
"description": "Unique Identifier for the Event.",
"pattern": "^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$",
"minLength": 30,
"maxLength": 30,
"example": "ev0105ARZ3NDEKTSV4RRFFQ69G5FAV"
},
"eventType": {
"type": "string",
"description": "This is a list of all the types of events we currently send. RECURRING_PAYMENT_CONFIRMED",
"enum": [
"RECURRING_PAYMENT_CONFIRMED"
]
"example": RECURRING_PAYMENT_CONFIRMED
},
"occuredAt": {
"type": "string",
"description": "Date & Time at which the event has occurred.",
"format": "date-time",
"example": 2025-02-17T18:00:00Z
},
"apiVersion": {
"type": "string",
"description": "The Moneris API Version used to populate the event payload.",
"nullable": true,
"example": 2024-09-17
},
"objectId": {
"type": "string",
"description": "Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.",
"nullable": true,
"example": pi0105ARZ3NDEKTSV4RRFFQ69G5FAV
},
"href": {
"type": "string",
"description": "Uniform resource locator to retrieve resource details",
"format": "uri-reference",
"nullable": true,
"example": /payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV
},
"correlationId": {
"type": "string",
"description": "Correlation Id transmitted during the original request.",
"nullable": true,
"example": "f0d4c76f-f129-4b91-92a3-9a120829bbe5",
},
"data": {
"type": "object",
"description": "Full representation of the resource that triggered the event. For Payments, it will be the Payment object",
"nullable": true
}
}

Response 200 OK

Webhook event processed successfully

Response 400 Bad Request

An error has occured while processing webhook event

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

idempotencyKey

string

required

length between 1 and 36

A Unique Identifier that is required for handling idempotent requests.

Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."

orderId

string | null

^[a-zA-Z0-9-_]+$

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

invoiceNumber

string | null

Submits a unique value to identify a transaction that is logged by Moneris Solutions.

subscriptionType

string

enum

required

Subscription Type.

RECURRING: Recurring Subscription.

Allowed:

billingDetails

object

required

Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.

callbackUrl

string | null

URL-encoded, fully qualified callback URL that receives subscription notification.

Note: Request with URL that is not URL-encoded will be rejected for security reasons.

Example (URL-encoded): https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123

oneTimeAmount

object | null

The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059

paymentMethod

required

Subscription Payment method details.

Note: If defined, this will result in the creation of a Permanent Payment Method as defined in the Payment Method API.

ecommerceIndicator

string

enum

Defaults to SSL_MERCHANT

The ecommerce indicator (ECI) specifies the level of security that was used to obtain the cardholder's payment data.
It is sent by the merchant and returned by the issuer.
When returned in the response, it can be different from the value sent in the request in case transaction was downgraded by the issuer.

Allowed:

customerId

string | null

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

Unique Identification for the Customer

customerReference

string | null

Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.

customData

object | null

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

dynamicDescriptor

string | null

Merchant defined description sent on a per-transaction basis that will appear on the credit card statement.

Dependent on the card Issuer, the statement will typically show the dynamic descriptor appended to the merchant's existing business name separated by the '/' character.

Note: The combined length of the merchant's business name, forward slash '/' character, and the dynamic descriptor may not exceed 22 characters.

threeDSecureData

Data related to 3-D Secure

ipv4

string | null

Internet Protocol version 4 (IPv4).

ipv6

string | null

Internet Protocol version 6 (IPv6).

Headers

Api-Version

string

required

Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

X-Correlation-Id

string

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist.
Merchants are to echo back the value with every request that is part of the call flow."

X-Merchant-Id

string

required

length between 13 and 13

Thirteen character identification code.

Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Subscription created successfully

400Bad Request.

401Not authorized. The user does not have a valid API Key or Access Token.

403Forbidden. The user does not have permission to access the requested resource.

409Request could not be completed due to a conflict with resource state or existing idempotency key.

422The API cannot complete the requested action due to semantic or business validation errors.

429Too Many Requests

500Unexpected error.

503Service Temporarily Unavailable