How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Moneris Payment Methods API

Create and Manage payment methods

Moneris Payment Methods API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Methods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 59 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.

5 operations 2 paths 59 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.6.1
Base URL
https://api.moneris.io
Authentication
API Key, OAuth 2.0
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Moneris Payment Methods 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Methods 5

Create and Manage payment methods

POST
/payment-methods
Create Payment Method
createPaymentMethod 3 params body → 201400401403409422429500
GET
/payment-methods
List payment methods
getPaymentMethods 7 params → 200400401403429500503
DELETE
/payment-methods/{payment-method-id}
Delete Payment Method
deletePaymentMethod 4 params → 204401403404429500503
GET
/payment-methods/{payment-method-id}
Retrieve Payment Method
getPaymentMethod 4 params → 200401403404429500503
PUT
/payment-methods/{payment-method-id}
Update Payment method
updatePaymentMethod 4 params body → 200400401403404409422429

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are paymentMethod (9 properties), cardInformation (8 properties), error (7 properties), paymentMethodList (6 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
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…
cardBrand
stringnull
Displays the card brand name associated with the card type.
createGooglePayEncryptedWalletPaymentMethodRequest
paymentMethod
object
Payment method response object
9 properties 4 required
createPaymentMethodRequest
1 required
first
stringnull
Pagination link pointing to the first page.
card
object
Card details
4 properties 4 required
createApplePayEncryptedWalletPaymentMethodRequest
updatePaymentMethodRequest
1 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.
cardInformation
object
Information about the card being used for the transaction
8 properties
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.
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.
paymentMethodList
object
List of Payment Methods
6 properties 1 required
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).
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.…
next
stringnull
Pagination link pointing to the next page.
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
createApplePayDecryptedWalletPaymentMethodRequest
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
createPermanentTokenPaymentMethodRequest
applePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
createCardPaymentMethodRequest
modifiedAt
stringnull
Time at which the object was modified
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
createTemporaryTokenPaymentMethodRequest
createGooglePayDecryptedWalletPaymentMethodRequest
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.
merchantId
string
Thirteen character long identification provided to merchants by Moneris.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

moneris-payment-methods-api-openapi.yml Raw ↑

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 Payments API
Moneris Products API
Moneris Refunds API
Moneris Subscriptions API
Moneris Surcharge Lookup API
Where this information came from

This is an independent, third-party profile of Moneris Payment Methods 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.