Moneris Installments API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Installments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
1 operation
across 1 path,
and defines 66 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.
The identity and technical contract details declared by the specification.
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
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…
language
string
Provides the two letter language code according the ISO 639-1 standard. For a complete list of language codes, visit: https://en.wikipedia.org/wiki/ListofISO63…
url
string
Provides the Uniform Resource Identifier based on the RFC 3986 standard. For additional details, visit: https://www.rfc-editor.org/rfc/rfc3986.
cardBrand
stringnull
Displays the card brand name associated with the card type.
money
object
Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
2 properties
2 required
paymentMethod
object
Payment method response object
9 properties
4 required
card
object
Card details
4 properties
4 required
installmentIdReference
string
A Visa-generated, alphanumeric, unique, and short human-readable friendly name for Installment Plan.
installmentTermsAndConditionsVersion
string
Installment Plan Terms and Conditions Version. Version of the Terms & Conditions accepted by the consumer. The version is auto-incremented every time an update…
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.
paymentMethodRequest
Payment method details
1 required
installmentName
string
Name of the installment plan. This may not be unique.
cardInformation
object
Information about the card being used for the transaction
8 properties
installmentEligibilityResponse
object
Installment Eligibility response.
2 properties
2 required
googlePayDecryptedWallet
Google Pay wallet details after decrypting the token.
1 required
walletCryptogram
string
Token cryptogram or encoded Base64 for Interac Wallets.
installmentTermsAndConditionsText
string
Text of the Terms and Conditions for Installment Plan.
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
lastInstallment
object
Cost details (fee and principal) for the last Installment.
2 properties
1 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.
installmentFrequency
string
Supported Tenure Types for a plan.
installmentCount
integer
Maximum number of installments that can be in the Plan Acceptance created from this plan.
paymentMethodWithId
object
Use existing unique payment method identifier.
2 properties
2 required
installmentType
string
Type of the installment plan.
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).
installmentEligibilityRequest
object
Installment Eligibility request.
4 properties
3 required
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…
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.…
installmentTermsAndConditions
object
4 properties
4 required
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."
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
installmentPlan
object
Installment plan details.
14 properties
14 required
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
applePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
modifiedAt
stringnull
Time at which the object was modified
customData
objectnull
Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
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…
installmentId
string
Visa-generated identifier for an Installment plan.
contactDetails
objectnull
Contact details
2 properties
installmentPromotionCode
stringnull
An external identifier to this plan provided by the issuer to Visa that identifies this Installment plan.
firstInstallment
object
Cost details (fee and principal) for the first Installment.
3 properties
1 required
cardPaymentMethodInformation
object
Details about the card used in the payment method.
5 properties
4 required
issuer
stringnull
Card issuer.
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
installmentPromotionId
stringnull
An external identifier provided by the issuer to Visa that identifies a program or promotion that is setup outside of Visa Installment Services.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Moneris publishes across the network.
