--- title: "Create Subscription" method: POST path: "/subscriptions" tags: ["Subscriptions"] --- # Create Subscription `POST /subscriptions` This operation is used to create a Subscription. #### Webhooks Webhook Definition Details application/json #### Webhook Request Body This is the base definition for all event messages. It contains the common properties that are shared across all events. Name Required Additional Info Description eventId true string Identifier of the triggered event. Can be used as an idempotency key to detect duplicates. eventType true string This is a list of all the types of events we currently send. * RECURRING\_PAYMENT\_CONFIRMED: A payment transaction has been executed. occuredAt true date-time the timestamp of when the event occurred (not necessarily the same of when it was delivered) apiVersion false string The Moneris API Version used to populate the event payload. objectId false string Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc. href false string Uniform resource locator to retrieve resource details. correlationId false string Correlation Id transmitted during the original request. This is useful to correlate between multiple events corresponding to same flow. data false [payment](/api-details#api=moneris-api-2025-02-20-preview&operation=createPayments "payment") The Payment data associated with the event. json Copy { "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 ## Request body - CreateSubscriptionRequest - `idempotencyKey` string, required — 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, nullable — 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, nullable — Submits a unique value to identify a transaction that is logged by Moneris Solutions. - `subscriptionType` 'RECURRING', required — Subscription Type. - RECURRING: Recurring Subscription. - `billingDetails` BillingDetails, 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. - `billingIntervalUnit` 'DAY' | 'WEEK' | 'MONTH' | 'END_OF_MONTH', required — Controls whether the recurring series occurs on a: daily (`DAY`), weekly (`WEEK`), or monthly (`MONTH`) basis. To ensure regular schedules, use `END_OF_MONTH` for schedules occurring on the last day of each month. - `billingIntervalFrequency` integer, required — Number of interval units passing between subscribed payments. Frequencies higher than 1 cause the subscription to skip intervals, such as bi-weekly (2 weeks) or annual subscriptions (12 months). - `billingIntervalCount` integer, required — How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count. - `billingAmount` object, required — The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `billingStartDate` string, date, required — Date of the first future subscription billing transaction. This value must be a date in the future. - `callbackUrl` string, nullable — 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, nullable — The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `paymentMethod` union, 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. - SubscriptionPaymentMethodIdRequest — Use existing unique payment method identifier. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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, required — Unique Identifier of the payment method. - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodCardRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `card` Card, required — Card details - `cardNumber` string, required — Identifies the customer's credit or debit card number (Primary Account Number). - `expiryMonth` integer, required — Card expiration month. Format must be MM - `expiryYear` integer, required — Displays the card expiration year. Accepted format: YYYY - `cardSecurityCode` string, required — 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 stored for subsequent use or displayed as part of the receipt information. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodTemporaryTokenRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `temporaryToken` string, required — 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. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodPermanentTokenRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `permanentToken` string, required — 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. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `credentialOnFileInformation` CredentialOnFileInformation, required — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodApplePayEncryptedWalletRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `displayName` string, required — Display Name - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'INTERAC' | 'DISCOVER', required — Card Brand. - `applePayVersion` 'EC_V1' | 'RSA_V1', required — Version information about the payment token. - EC_V1: For ECC-encrypted data - RSA_V1: For RSA-encrypted data - `data` string, byte, required — Encrypted payment data. Base64 encoded as a string. - `signature` string, required — Signature of the payment and header data, Base64 encoded as a string. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm. Can be a detached PKCS #7 signature, Base64 encoded as a string - `publicKeyHash` string, required — Hash of the X.509 encoded public key bytes of the merchant’s certificate. Can be either a base64 encoded or SHA-256 Hash string. - `ephemeralPublicKey` string, byte, required — Ephemeral public key bytes. Only for RSA_v1. Can be either a base64 encoded string or X.509 bytes. - `applePayTransactionId` string, required — The Apple Pay unique identifier for a transaction such as an in-app purchase, restored in-app purchase, or subscription renewal. - `walletIndicator` 'IN_APPLICATION' | 'IN_BROWSER', required — Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions. **NOTE**: This field is mandatory for wallet transactions and is case senstive." - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodApplePayDecryptedWalletRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `applicationPrimaryAccountNumber` string, required — The unique identifier for the primary account number for the payment card. - `expiryMonth` integer, required — Card expiration month. Format must be MM - `expiryYear` integer, required — Displays the card expiration year. Accepted format: YYYY - `deviceManufacturerIdentifier` string, nullable — Hex-encoded device manufacturer identifier - `dataType` 'THREE_D_SECURE' | 'EMV', required — Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions and is mandatory for INTERAC® e-Commerce Apple Pay and Google Pay transactions. - `cryptogram` string, required — Token cryptogram or encoded Base64 for Interac Wallets. - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'INTERAC' | 'DISCOVER', required — Card Brand. - `walletEcommerceIndicator` string, nullable — ECI Indicator as provided by the Wallet. - `walletIndicator` 'IN_APPLICATION' | 'IN_BROWSER', required — Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions. **NOTE**: This field is mandatory for wallet transactions and is case senstive." - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodGooglePayEncryptedWalletRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'INTERAC', required — Card Brand. - `signature` string, required — Verifies that the message came from Google. It's base64-encoded, and created with ECDSA by the intermediate signing key. - `googlePayProtocolVersion` string, required — Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time, if needed. Must be fowarded as provided by Google Pay. - `signedMessage` string, required — A JSON object serialized as an HTML-safe string that contains the encryptedMessage, ephemeralPublicKey, and tag. It's serialized to simplify the signature verification process. - `walletIndicator` 'IN_APPLICATION' | 'IN_BROWSER', required — Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions. **NOTE**: This field is mandatory for wallet transactions and is case senstive." - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - SubscriptionPaymentMethodGooglePayDecryptedWalletRequest — Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodSource` 'PAYMENT_METHOD_ID' | 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `gatewayMerchantId` string, nullable — Gateway unique store id - `messageExpiration` string, date-time, nullable — Date and time at which the message expires. Integrators should reject any message that's expired. - `messageId` string, nullable — A unique ID that identifies the message in case it needs to be revoked or located at a later time. - `walletSource` 'CARD' | 'TOKENIZED_CARD', required — The type of the payment credential. Supported values are: - CARD - TOKENIZED_CARD - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'INTERAC', required — Card Network. - `walletIndicator` 'IN_APPLICATION' | 'IN_BROWSER', required — Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions. **NOTE**: This field is mandatory for wallet transactions and is case senstive." - `cardDetails` GooglePayDecryptedCardDetails, required — The payment credential itself. The format of this object is determined by the paymentMethod - `personalAccountNumber` string, required — The personal account number charged. This string contains only digits. - `expiryMonth` integer, required — Card expiration month. Format must be MM - `expiryYear` integer, required — Displays the card expiration year. Accepted format: YYYY - `authenticationMethod` string, nullable — The authentication method of the card transaction. Must be forwarded as provided by Google Pay. - `cryptogram` string, nullable — Token cryptogram or encoded Base64 for Interac Wallets. - `walletEcommerceIndicator` string, nullable — ECI Indicator as provided by the Wallet. - `credentialOnFileInformation` object, nullable — Contains fields related to the Credential on File (CoF) - `paymentIndicator` 'UNSCHEDULED_CREDENTIAL_ON_FILE' | 'RECURRING' | 'MERCHANT_INITIATED' | 'VARIABLE_RECURRING' | 'CUSTOMER_INITIATED', required — Indicates the current or intended use of the credentials - **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only) - **RECURRING**: recurring transaction - **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction - **VARIABLE_RECURRING**: recurring variable payment transaction - **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction - `paymentInformation` 'FIRST' | 'SUBSEQUENT', required — Describes whether the transaction is the first or subsequent in the series - `issuerId` string, nullable — 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 transaction. - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `ecommerceIndicator` 'MAIL_TELEPHONE_ORDER_SINGLE' | 'MAIL_TELEPHONE_ORDER_RECURRING' | 'MAIL_TELEPHONE_ORDER_INSTALMENT' | 'MAIL_TELEPHONE_ORDER_UNKNOWN' | 'AUTHENTICATED_ECOMMERCE' | 'NON_AUTHENTICATED_ECOMMERCE' | '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. - `customerId` string, nullable — Unique Identification for the Customer - `customerReference` string, nullable — Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `dynamicDescriptor` string, nullable — 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` union — Data related to 3-D Secure - object - `threeDSecureAuthenticationId` string, required — Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc. - object - `threeDSecureAuthenticationValue` string, nullable, required — **CAVV**: Cardholder Authentication Verification Value Provided during a payment request to authenticate the card user. - `threeDSecureVersion` string, required — Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1. - `threeDSecureServerTransactionId` string, uuid, required — 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 Request transaction. - `threeDSecureDirectoryServerTransactionId` string, uuid, required — Universally unique transaction identifier assigned by the 3DS Directory Server (DS) to identify a single transaction. - `ipv4` string, ipv4, nullable — Internet Protocol version 4 (IPv4). - `ipv6` string, ipv6, nullable — Internet Protocol version 6 (IPv6). ## Response `201` Subscription created successfully - Subscription - `subscriptionId` string, required — Unique Identification for the Subscription - `merchantId` string, required — Thirteen character long identification provided to merchants by Moneris. - `orderId` string, nullable, required — 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, nullable — Submits a unique value to identify a transaction that is logged by Moneris Solutions. - `createdAt` string, date-time, required — Time at which the object was created - `customerId` string, nullable — Unique Identification for the Customer - `customerReference` string, nullable — Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier. - `modifiedAt` string, date-time, nullable — Time at which the object was modified - `subscriptionType` 'RECURRING', required — Subscription Type. - RECURRING: Recurring Subscription. - `billingInformation` BillingInformation, 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. - `billingIntervalUnit` 'DAY' | 'WEEK' | 'MONTH' | 'END_OF_MONTH', required — Controls whether the recurring series occurs on a: daily (`DAY`), weekly (`WEEK`), or monthly (`MONTH`) basis. To ensure regular schedules, use `END_OF_MONTH` for schedules occurring on the last day of each month. - `billingIntervalFrequency` integer, required — Number of interval units passing between subscribed payments. Frequencies higher than 1 cause the subscription to skip intervals, such as bi-weekly (2 weeks) or annual subscriptions (12 months). - `billingIntervalCount` integer, required — How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count. - `billingAmount` object, required — The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `billingStartDate` string, date, required — Date of the first future subscription billing transaction. This value must be a date in the future. - `nextBillingDate` string, date, nullable — Date on which the next payment will occur - `billingEndDate` string, date, nullable — Date on which the subscription will end. - `callbackUrl` string, nullable — 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 - `paymentMethod` PaymentMethod, required — Payment method response object - `paymentMethodId` string, required — Unique Identifier of the payment method. - `merchantId` string, required — Thirteen character long identification provided to merchants by Moneris. - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card. - `cardholderName` string, required — Cardholder name - `companyName` string, nullable — Identifies the associated company name - `contactDetails` ContactDetails, nullable — Contact details - `phoneNumber` string, nullable — Phone number. - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322 - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided. - `unitNumber` string, nullable — Unit number - `streetNumber` string, nullable — Street number - `streetName` string, nullable — Street name - `city` string, nullable — Identifies the city. - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code - `postalCode` string, nullable — Postal or zip code - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. - `paymentMethodInformation` CardPaymentMethodInformation, required — Details about the card used in the payment method. - `paymentMethodType` 'CARD', required — The type of Payment Method being used. It can be: - Card. - `paymentMethodSource` 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — 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. - `cardInformation` CardInformation, required — Information about the card being used for the transaction - `bankIdentificationNumber` string, nullable — **BIN**: Bank Identification Number Consists of the first six to eight digits of the Primary Account Number (PAN) and identifies the relevant payment network and the specific payment issuing institution. - `lastFour` string, nullable — Last 4 digits of the card. - `expiryMonth` integer — Card expiration month. Format must be MM - `expiryYear` integer — Displays the card expiration year. Accepted format: YYYY - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'JCB' | 'DISCOVER' | 'INTERAC' | 'UNIONPAY' | 'GIFT_MONERIS' | 'GIFT_DATACANDY' | 'GIFT_GIVEX' | 'null', nullable — Displays the card brand name associated with the card type. - `cardType` 'CREDIT' | 'DEBIT' | 'DOMESTIC_DEBIT' | 'PREPAID_RELOADABLE' | 'PREPAID_NON_RELOADABLE' | 'UNKNOWN' | 'GIFT' | 'LOYALTY' | 'FLEET' | 'CORPORATE', nullable — Specifies the intended card use; i.e. debit or credit. - `cardFingerprint` string, nullable — Unique card identifier. Fingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple payments methods are attached to the same underlying card, and assists merchants identify individual customers across various channels; i.e. loyalty programs. - `issuer` string, nullable — Card issuer. - `paymentAccountReference` string, nullable — Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism. - `storePaymentMethod` 'DO_NOT_STORE' | 'CARDHOLDER_INITIATED' | 'MERCHANT_INITIATED', required — Store this payment method created through this payment for future use. - DO_NOT_STORE: Payment method will not be stored. - CARDHOLDER_INITIATED: Payment method to be stored and can only re-used with cardholder's consent. Limited to store, pre-authorisation, and card validations." - MERCHANT_INITIATED: Payment method to be stored and can be reused without the cardholder's consent. For example, subscriptions. - `createdAt` string, date-time, required — Time at which the object was created - `modifiedAt` string, date-time, nullable — Time at which the object was modified - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `subscriptionStatus` 'DECLINED' | 'DECLINED_RETRY' | 'PAUSED' | 'ACTIVE' | 'CANCELED' | 'COMPLETED', required — Subscription Status description. - `oneTimeAmount` object, nullable — The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `credentialOnFileResponse` CredentialOnFileResponse, nullable — Contains fields related to the Credential on File (CoF) - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059 - `amount` integer, required — Amount - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217 - `issuerId` string, nullable — 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 transaction. - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response. - `payments` PaymentReference[] — List of payments - `paymentId` string, required — Unique Identification for the Payment - `href` string, uri-reference, nullable — Payment Reference URL ## Other responses - `400` — Bad Request. - `401` — Not authorized. The user does not have a valid API Key or Access Token. - `403` — Forbidden. The user does not have permission to access the requested resource. - `409` — Request could not be completed due to a conflict with resource state or existing idempotency key. - `422` — The API cannot complete the requested action due to semantic or business validation errors. - `429` — Too Many Requests - `500` — Unexpected error. - `503` — Service Temporarily Unavailable --- [API](https://skmtc.net/moneris/apis/moneris-api.md) · [All operations](https://skmtc.net/moneris/apis/moneris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneris/moneris-api/revisions/edefcc925b74/schema)