Moneris Subscriptions API
Perform and Manage Subscriptions
Moneris Subscriptions API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 8 operations across 6 paths, and defines 101 schemas. It is described by OpenAPI 3.2.0, at version 2.6.1.
Requests are made against 2 base URLs: https://api.sb.moneris.io, https://api.moneris.io.
8 operations
6 paths
101 schemas
2 GET1 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Moneris Subscriptions API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-Api-Key (ApiKeyAuth).
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 14 scopes.
ApiKeyAuth— An API key is a token that a client provides when making API calls. API keys are supposed to be a secret that only the client and server know about.OAuth2— OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server. OAuth relies on authentication scenarios, that all…
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 2 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Subscriptions 8
Perform and Manage Subscriptions
POST
/subscriptions
Create Subscription
GET
/subscriptions
List subscriptions
GET
/subscriptions/{subscription-id}
Retrieve Subscription
PATCH
/subscriptions/{subscription-id}
Update Subscription
POST
/subscriptions/{subscription-id}/cancel
Cancel Subscription
POST
/subscriptions/{subscription-id}/extend
Extend Subscription
POST
/subscriptions/{subscription-id}/pause
Pause Subscription
POST
/subscriptions/{subscription-id}/resume
Resume Subscription
Schemas 101
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are subscription (17 properties), createSubscriptionRequest (16 properties), paymentMethod (9 properties), cardInformation (8 properties). Each schema is shown below with its type and property counts.
expiryYear
integer
Displays the card expiration year. Accepted format: YYYY
paymentMethodCard
Credit/Debit/Gift Card payment method details.
2 required
cardholderName
string
Cardholder name
paymentMethodPermanentToken
A Permanent Token is issued by Moneris to the merchant and represents the card details. This option is used for legacy purposes.
2 required
companyName
stringnull
Identifies the associated company name
threeDSecureAuthenticationValue
stringnull
CAVV: Cardholder Authentication Verification Value Provided during a payment request to authenticate the card user.
cardSecurityCode
string
CVD value located on credit card. The CVD value (supplied by the cardholder) must only be passed to the payment gateway. Under no circumstances may it be store…
subscriptionPaymentMethodCardRequest
billingInformation
object
Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cy…
7 properties
5 required
threeDSecureWithAuthenticationId
object
1 property
1 required
cardBrand
stringnull
Displays the card brand name associated with the card type.
subscriptionStatus
string
Subscription Status description.
pauseSubscriptionRequest
object
2 properties
1 required
paymentMethod
object
Payment method response object
9 properties
4 required
callbackUrl
stringnull
URL-encoded, fully qualified callback URL that receives subscription notification. Note: Request with URL that is not URL-encoded will be rejected for security…
first
stringnull
Pagination link pointing to the first page.
card
object
Card details
4 properties
4 required
paymentId
string
Unique Identification for the Payment
createSubscriptionRequest
object
16 properties
4 required
billingDetails
object
Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cy…
5 properties
5 required
resourceId
string
Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.
token
string
Created when a temporary token is created and returned. This acts as a unique profile identifier, and is a required value for temporary token transactions.
extendSubscriptionRequest
object
Adds the given number of subscription transactions to the current (remaining) number. This can be used if a customer decides to extend a membership/subscriptio…
3 properties
2 required
ecommerceIndicator
string
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…
ipv6
stringnull
Internet Protocol version 6 (IPv6).
cardInformation
object
Information about the card being used for the transaction
8 properties
googlePayDecryptedWallet
Google Pay wallet details after decrypting the token.
1 required
credentialOnFileInformation
object
Contains fields related to the Credential on File (CoF)
4 properties
2 required
billingIntervalUnit
string
Controls whether the recurring series occurs on a: daily (DAY), weekly (WEEK), or monthly (MONTH) basis. To ensure regular schedules, use ENDOFMONTH for schedu…
walletCryptogram
string
Token cryptogram or encoded Base64 for Interac Wallets.
billingIntervalFrequency
integer
Number of interval units passing between subscribed payments. Frequencies higher than 1 cause the subscription to skip intervals, such as bi-weekly (2 weeks) o…
paymentAccountReference
stringnull
Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism.
parameterError
object
Request property or header related error.
4 properties
2 required
createdAt
string
Time at which the object was created
walletEcommerceIndicator
stringnull
ECI Indicator as provided by the Wallet.
error
object
Error response details.
7 properties
1 required
googlePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
paymentMethodRequestSource
string
The source of Payment Method being used. It can be: - The Id of a Payment Method already created. - Permanent Token. - Temporary Token. - Card. - E-Wallet.
paymentMethodId
string
Unique Identifier of the payment method.
ipv4
stringnull
Internet Protocol version 4 (IPv4).
paymentMethodWithId
object
Use existing unique payment method identifier.
2 properties
2 required
subscriptionPaymentMethodRequest
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.
storePaymentMethod
string
Store this payment method created through this payment for future use. - DONOTSTORE: Payment method will not be stored. - CARDHOLDERINITIATED: Payment method t…
cardNumber
string
Identifies the customer's credit or debit card number (Primary Account Number).
subscriptionPaymentMethodIdRequest
googlePayDecryptedCardDetails
object
The payment credential itself. The format of this object is determined by the paymentMethod
6 properties
3 required
cardFingerprint
stringnull
Unique card identifier. Fingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple…
cancelSubscriptionRequest
object
3 properties
1 required
updateSubscriptionDetails
object
Update Subscription details such as the subscription billing cycle, amount, and payment method.
7 properties
originalAmount
objectnull
Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059
2 properties
2 required
cardholderInformation
objectnull
Information about the holder of the card.
2 properties
1 required
dataType
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions and is mandatory for INTERAC® e-Commerce Ap…
walletIndicator
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions.…
next
stringnull
Pagination link pointing to the next page.
dynamicDescriptor
stringnull
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 ty…
idempotencyKey
string
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."
subscriptionId
string
Unique Identification for the Subscription
credentialOnFileResponse
objectnull
Contains fields related to the Credential on File (CoF)
2 properties
paymentMethodRequestBase
object
Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API.
5 properties
1 required
threeDSecureData
objectnull
Data related to 3-D Secure
paymentMethodTemporaryToken
A Temporary Token is issued by Moneris to the merchant and represents the card details. Please review the Hosted Tokenization feature documentation to learn ho…
2 required
apiVersion
string
The endpoint's API Version. Must be provided through headers.
expiryMonth
integer
Card expiration month. Format must be MM
applePayDecryptedWallet
Apple Pay wallet details after decrypting the token.
1 required
currency
string
Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO4217
subscriptionIntervalCount
integer
How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count.
paymentInformation
string
Describes whether the transaction is the first or subsequent in the series
issuerId
stringnull
Displays a unique identifier for the card holder's stored credentials. This information is returned from the card brand when processing a Credential on File tr…
applePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
modifiedAt
stringnull
Time at which the object was modified
resumeSubscriptionRequest
object
2 properties
1 required
threeDSecureServerTransactionId
string
Indicates information required when sending a version 3-D Secure 2.0+ transaction. This data is obtained from a CAVV Lookup Request or MPI 3DS Authentication R…
dateTime
string
Date & Time
customData
objectnull
Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
self
stringnull
Pagination link pointing to the current page.
deviceManufacturerIdentifier
stringnull
Hex-encoded device manufacturer identifier
orderId
stringnull
Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transacti…
customerId
string
Unique Identification for the Customer
subscriptionType
string
Subscription Type. - RECURRING: Recurring Subscription.
subscription
object
17 properties
8 required
paymentReference
objectnull
Payment reference. Can be expanded into full payment details using the expand query parameter.
2 properties
1 required
subscriptionPaymentMethodApplePayEncryptedWalletRequest
paymentIndicator
string
Indicates the current or intended use of the credentials - UNSCHEDULEDCREDENTIALONFILE: unscheduled Credential on File (first transactions only) - RECURRING: r…
threeDSecureVersion
string
Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1.
subscriptionPaymentMethodPermanentTokenRequest
subscriptionPaymentMethodApplePayDecryptedWalletRequest
subscriptionList
object
Paginated List of subscriptions.
6 properties
1 required
contactDetails
objectnull
Contact details
2 properties
last
stringnull
Pagination link pointing to the last page.
cardPaymentMethodInformation
object
Details about the card used in the payment method.
5 properties
4 required
previous
stringnull
Pagination link pointing to the previous page.
issuer
stringnull
Card issuer.
invoiceNumber
stringnull
Submits a unique value to identify a transaction that is logged by Moneris Solutions.
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
subscriptionPaymentMethodGooglePayDecryptedWalletRequest
subscriptionPaymentMethodTemporaryTokenRequest
subscriptionPaymentMethodGooglePayEncryptedWalletRequest
amount
integer
Amount
paymentUri
stringnull
Payment Reference URL
threeDSecureWithAuthenticationData
object
4 properties
4 required
threeDSecureDirectoryServerTransactionId
string
Universally unique transaction identifier assigned by the 3DS Directory Server (DS) to identify a single transaction.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Moneris 12
Other APIs Moneris publishes across the network.
Moneris 3D Secure API
Moneris Customers API
Moneris Disputes API
Moneris Installments API
Moneris Kount API
Moneris Merchant Onboarding API
Moneris Multi-Currency Pricing Rate Lookup API
Moneris Payment Methods API
Moneris Payments API
Moneris Products API
Moneris Refunds API
Moneris Surcharge Lookup API
#Subscription
Where this information came from
This is an independent, third-party profile of Moneris Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.