Moneris Payments API
Perform and Manage payments
Moneris Payments API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 6 operations across 5 paths, and defines 127 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.
6 operations
5 paths
127 schemas
2 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Moneris Payments 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 6
Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Payments 6
Perform and Manage payments
POST
/payments
Create Payment
GET
/payments
List Payments
GET
/payments/{payment-id}
Retrieve Payment
POST
/payments/{payment-id}/cancel
Cancel Payment
POST
/payments/{payment-id}/complete
Complete Payment
POST
/payments/{payment-id}/increment
Increment Payment
Schemas 127
The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are payment (26 properties), createPaymentRequest (19 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
storeApplePayDecryptedWalletRequest
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
refundDetails
objectnull
Refund details if any has occured.
2 properties
1 required
multipleCompletions
array
List of all Multiple Completion transactions.
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…
completionRequest
object
7 properties
1 required
incrementalAuthorizationIndicator
boolean
This flag is used for processing the Pre-Authorization transaction as an Incremental Authorization transaction.
createPaymentRequest
object
Request body, used to initiate a payment
19 properties
3 required
storePaymentMethodCardRequest
cardBrand
stringnull
Displays the card brand name associated with the card type.
threeDSecureWithAuthenticationId
object
1 property
1 required
cancelPaymentRequest
object
4 properties
1 required
refundReference
objectnull
Refund reference.
2 properties
1 required
message
stringnull
Displays response description returned from issuing institution. NOTE: This message should not be displayed on any cardholder facing materials. For receipt pur…
transactionDateTime
string
Indicates the date and time of the transaction.
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
first
stringnull
Pagination link pointing to the first page.
card
object
Card details
4 properties
4 required
paymentId
string
Unique Identification for the Payment
convenienceFeeDetails
objectnull
Contains information about a Convenience Fee transaction.
4 properties
3 required
installmentIdReference
string
A Visa-generated, alphanumeric, unique, and short human-readable friendly name for Installment Plan.
storePaymentMethodIdRequest
resourceId
string
Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.
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.
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…
storeGooglePayEncryptedWalletRequest
installmentAcceptanceId
string
Visa-generated identifier for a plan acceptance.
automaticCapture
boolean
- true: (Default) will prompt Moneris to capture the payment when it is authorized. This performs a Purchase transaction. - false: will prompt Moneris to place…
ipv6
stringnull
Internet Protocol version 6 (IPv6).
cardInformation
object
Information about the card being used for the transaction
8 properties
credentialOnFileInformation
object
Contains fields related to the Credential on File (CoF)
4 properties
2 required
googlePayDecryptedWallet
Google Pay wallet details after decrypting the token.
1 required
walletCryptogram
string
Token cryptogram or encoded Base64 for Interac Wallets.
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.
threeDSecureAuthenticationValueResult
stringnull
The Cardholder Authentication Verification Value (CAVV), the Account holder Authentication Value (AAV), and the American Express Verification Value (AEVV), are…
installmentPlanInformation
objectnull
Installment plan details, if an installment plan is selected
3 properties
3 required
storeGooglePayDecryptedWalletRequest
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.
cardSecurityCodeResult
stringnull
Indicates the Card Security Code validation result. - MATCH - NOMATCH - NOTPROCESSED - CVDNOTPRESENT - NOTCVDPRESENT - AMEXJCBMATCH - AMEXJCBINVALID - OTHER"
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.
subTotalAmount
objectnull
Sub total amount for the transaction. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
2 properties
2 required
storePaymentMethodRequest
Used to collect payment data needed to execute the transaction. Can also be used to collect and save customer payment instruments on file.
1 required
paymentMethodId
string
Unique Identifier of the payment method.
multiCurrencyPricingOptIn
string
Indicates if Multi-Currency Pricing is to be used for this transaction.
installmentStatus
string
Status of the Installment Plan.
payment
object
Returns a processed payment
26 properties
11 required
storePermanentToken
string
Store this payment method created through this payment for future use. - CARDHOLDERINITIATED: Payment method to be stored and can only re-used with cardholder'…
multipleCompletion
object
Multiple Completion object containing amount, processedAt time, and finalCompletion flag
3 properties
3 required
subscriptionReference
objectnull
Subscription reference, if this transaction is related to a subscription.
2 properties
1 required
ipv4
stringnull
Internet Protocol version 4 (IPv4).
storePaymentMethodTemporaryTokenRequest
authorizationCode
stringnull
Contains a value generated by the authorizer for an approved financial transactions. This operates as the authorizing host's transaction identification.
paymentMethodWithId
object
Use existing unique payment method identifier.
2 properties
2 required
storePaymentMethodPermanentTokenRequest
storePaymentMethod
string
Store this payment method created through this payment for future use. - DONOTSTORE: Payment method will not be stored. - CARDHOLDERINITIATED: Payment method t…
storeApplePayEncryptedWalletRequest
cardNumber
string
Identifies the customer's credit or debit card number (Primary Account Number).
convenienceFee
objectnull
Allows merchants to apply an additional charge to a customer's bill (with their consent) for the convenience of being able to pay for goods and services using…
1 property
1 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
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
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.
refundId
string
Unique Identification for the Refund
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."
incrementalAuthorization
object
Incremental Authorization object containing amount and processedAt time.
2 properties
2 required
subscriptionId
string
Unique Identification for the Subscription
incrementalAuthorizationRequest
object
4 properties
2 required
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
amountDetails
objectnull
Contains information pertaining to the subtotal, tip, and surcharge amounts of a Payment
3 properties
verificationDetails
object
Result Codes for CVD, AVS, 3DS
3 properties
threeDSecureData
objectnull
Data related to 3-D Secure
iso
string
Represents the Moneris response code for the equivalent International Organization for Standardization (ISO) response code.
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
statusDetails
object
Additional details about the transaction outcome.
6 properties
3 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
paymentList
object
Response body, returns a paginated list of payments
6 properties
1 required
paymentInformation
string
Describes whether the transaction is the first or subsequent in the series
responseCode
string
"Details Transaction Response Codes: - 50: Transaction declined NULL: Transaction not sent for authorization For a complete list of definitions, refer to the R…
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
installmentPlanDetails
objectnull
Installment plan application results.
6 properties
5 required
modifiedAt
stringnull
Time at which the object was modified
dateTime
string
Date & Time
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…
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…
incrementalAuthorizations
array
List of all previous incremental authorizations.
paymentIndicator
string
Indicates the current or intended use of the credentials - UNSCHEDULEDCREDENTIALONFILE: unscheduled Credential on File (first transactions only) - RECURRING: r…
installmentId
string
Visa-generated identifier for an Installment plan.
refundUri
stringnull
Refund Reference URL
threeDSecureVersion
string
Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1.
addressVerificationServiceResultCode
stringnull
Indicates the address verification result.
contactDetails
objectnull
Contact details
2 properties
last
stringnull
Pagination link pointing to the last page.
paymentStatus
string
Payment Status description.
cardPaymentMethodInformation
object
Details about the card used in the payment method.
5 properties
4 required
multiCurrencyPricingDetails
objectnull
Exchange rate for use in a subsequent MCP financial transaction
3 properties
3 required
multiCurrencyPricingTransactionRequest
objectnull
Multi-Currency Pricing (MCP) Object
2 properties
1 required
previous
stringnull
Pagination link pointing to the previous page.
processedAt
string
Time at which the object was processed
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.
tipAmount
objectnull
Total tip amount for the transaction. Note: The value must be in cents. Therefore $10.59 must be sent as 1059
2 properties
2 required
amount
integer
Amount
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 Products API
Moneris Refunds API
Moneris Subscriptions API
Moneris Surcharge Lookup API
#Payments
Where this information came from
This is an independent, third-party profile of Moneris Payments 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.