Moneris Terminal & Service Orders API
Manage Moneris Terminal & Service Orders
Moneris Terminal & Service Orders API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Terminal & Service Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 2 paths, and defines 133 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.
3 operations
2 paths
133 schemas
1 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Moneris Terminal & Service Orders 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 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Terminal & Service Orders 3
Manage Moneris Terminal & Service Orders
POST
/onboarding/merchants/{merchant-id}/orders
Create Order
GET
/onboarding/merchants/{merchant-id}/orders/{merchant-order-id}
Retrieve order by Id
PUT
/onboarding/merchants/{merchant-id}/orders/{merchant-order-id}
Update an order by ID
Schemas 133
The contract defines 133 schemas that model the data the API accepts and returns. The most detailed are order (54 properties), monerisGatewayFeeDetails (34 properties), productDetails (22 properties), createStandardOrderRequest (19 properties). Each schema is shown below with its type and property counts.
monerisGoPortalFeeDetails
objectnull
A list of fees associated with Moneris Go Portal.
2 properties
isExpeditedOrder
boolean
A boolean flag indicating whether an order is being processed as a rush or expedited order.
depositType
stringnull
Indicates the type of deposit arrangement for the merchant account.
companyName
stringnull
Identifies the associated company name
otherFinancialInstitutionCards
array
A list of other financial institution cards.
monerisGatewayFeeDetails
objectnull
A list of fees associated to Moneris Gateway.
34 properties
foreignCardOriginCode
stringnull
A code used to identify the origin of a foreign card in a transaction under the card brand plan.
merchantDiscountRate
number
The merchant discount rate applied to transactions under transaction plan.
cardNotPresentConfigurationCode
stringnull
A configuration code used to identify variable settings for transactions.
isApproved
boolean
A boolean flag to indicate whether the fee has been approved for inclusion in the transaction.
software
stringnull
Indicates the software version or platform running on the terminal device.
representativeCode
stringnull
A code that identifies the representative agent associated with the order.
updateOrderRequest
Represents the payload for updating an order.
confirmation
objectnull
An object containing the confirmation details.
4 properties
partnerName
stringnull
The name of the partner that referred the lead to the business.
merchantNumber
stringnull
Identifies the merchant within he acquirer's system.
transactionFeeParameterCode
stringnull
The code that identifies the parameters associated with transaction fees for a specific card plan.
updateStandardOrderRequest
object
Represents the payload for updating an order.
18 properties
2 required
ueat
objectnull
An object containing details about the Ueat product.
9 properties
tax
object
An object that contains information about the tax applied to an order fee.
2 properties
2 required
lastName
stringnull
Last name.
maximumDisqualifiedTransactionMerchantDiscountRate
number
The maximum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.
programs
array
A list of programs associated with the card plan.
bookmark
objectnull
An object containing details about the Bookmark product.
7 properties
payDropPlusFeeDetails
objectnull
A list of fees associated with PayD Pro Plus.
1 property
assessmentPlan
object
An object containing all details related to assessment plan.
4 properties
address
object
The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
7 properties
money
object
Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
2 properties
2 required
selectedPlans
array
A list of selected plans associated with the card plan.
pointOfSaleType
stringnull
Specifies the type of point of sale terminal being used.
otherFinancialInstitutionCardType
stringnull
Represents the specific type of card used within the OFI institution card plan.
terminalName
string
The name of the terminal.
waivePeriod
stringnull
Specifies the period which the fee is waived and not charged to the user.
orderCreatedBy
stringnull
The individual responsible for creating the order.
firstName
stringnull
First name.
solutionId
integer
A unique identifier for the solutions object.
counterTopTerminals
array
A list of payment terminals available at the counter.
pinpadCableType
stringnull
Specifies the type of the cable used to connect the PIN pad to the terminal.
monerisAdvanceFeeDetails
objectnull
A list of fees associated with Moneris Advance.
2 properties
addressee
object
a (natural or legal) person that gets addressed
4 properties
2 required
monerisGoPortal
objectnull
An object containing the Moneris Go Portal details.
2 properties
domesticCardOriginCode
stringnull
A code used to identify the origin of a domestic card in a transaction under the card brand plan.
p2pe
objectnull
An object containing details about the P2PE product.
3 properties
cardBrandPlans
array
A list of card brand items.
payDropPlus
objectnull
An object containing the PayD Pro Plus details.
1 property
ofiCardPlan
object
An object containing all details about the Ofi Card Plan.
10 properties
bookmarkPro
objectnull
An object containing details about the Bookmark Pro product.
2 properties
thirdPartyGiftCardFeeDetails
objectnull
An object representing the fees associated with third-party gift cards.
2 properties
monerisGoPointOfSaleRetailFeeDetails
objectnull
A list of fees associated with Moneris Go POS Retail.
1 property
productDetails
object
An object containing all details related to a product.
22 properties
parameterError
object
Request property or header related error.
4 properties
2 required
monerisGoAppetit
objectnull
An object containing details about the Moneris Go Appetit product.
5 properties
error
object
Error response details.
7 properties
1 required
order
object
An object containing all the details related to the order details response.
54 properties
2 required
transferDeviceReference
stringnull
Indicates the identifier of the device being transferred as part of the current terminal request.
merchantDiscountRateType
stringnull
The type of Merchant Discount Rate applied to a card plan.
serviceFeeDetails
objectnull
An object containing the service fees details.
2 properties
marketSegment
stringnull
Identifies the specific customer or business segment targeted by a product or service.
feeTypeCode
stringnull
A code that identifies the type of fee associated with a transaction.
minimumMerchantDiscountRate
number
The minimum merchant discount rate that applies under the transaction plan.
accountNumber
stringnull
Attribute that represent the unique identifier for a bank account.
monerisGateway
objectnull
An object containing details about the Moneris Gateway product.
4 properties
cardOriginCode
stringnull
A code that indicates the origin of the card.
pricingModel
stringnull
Defines the pricing structure for the services provided.
isAutoAdjudicationRequired
boolean
A boolean flag indicating whether the auto adjudication process is required.
wirelessFeeDetails
objectnull
A list of fees associated with the wireless product.
2 properties
valueAddedServices
array
A list of value-added services associated with the order.
transactionPlan
object
An object containing the transaction plan details.
12 properties
userIdentifier
stringnull
A unique identifier assigned to a user within the system.
storeAndForward
objectnull
An object containing details about the Store and Forward product.
3 properties
collectionRate
integer
The rate at which payments are collected or deducted.
wixPointOfSale
objectnull
An object containing details about the Wix Point of Sale product.
4 properties
terminalCarrier
stringnull
The name of the mobile network operator or service provider.
solutions
array
A list of solution items.
agreementModelInformation
objectnull
An object containing the agreement model info details.
1 property
cardBrandTemplateIdentifier
stringnull
Unique identifier that links to a predefined template associated with a specific card brand.
foreignTransactionPercentageFee
number
The percentage fee applied to transactions involving foreign cards.
createPartnerBankOrderRequest
object
An object containing all the Order payload partner bank details.
5 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."
cardBrandPlan
object
An object containing the card brand plan details.
5 properties
middleName
stringnull
Customer's middle name.
webCreationPackagesFeeDetails
objectnull
An object representing the fees associated with web creation packages.
2 properties
petroTrak
objectnull
An object containing details about the PetroTrak product.
8 properties
multiCurrencyProduct
objectnull
An object containing details about the multi currency product.
5 properties
feeType
stringnull
Specifies the category or purpose of the fee applied to a transaction or service.
cardFeeDetails
objectnull
An object containing the card fees plan details.
3 properties
applicablePromotions
array
A list of promotion codes applicable to the order.
supplyName
string
Indicates the name of the good available for fulfillment or distribution.
createStandardOrderRequest
object
Represents the payload for submitting an order.
19 properties
4 required
transactionPlans
array
A list of transaction items.
installmentsFeeDetails
objectnull
An object representing the fees associated with installment payments.
2 properties
isCommunicationsOptOut
boolean
A boolean flag indicating whether the customer has opted out of receiving communications related to a franchise plan.
authorizationDescription
stringnull
A description of the authorization process or requirements for the transaction.
domesticTransactionPercentageFee
number
The percentage fee applied to transactions involving domestic cards or payments within the same country.
orderStatus
stringnull
Represents the current status of the order in the system.
apiVersion
string
The endpoint's API Version. Must be provided through headers.
createOrderRequest
Represents the payload for creating an order.
cardOption
stringnull
Specifies the type of card used or service option for a transaction plan.
disqualifiedTransactionMerchantDiscountRate
number
The merchant discount rate applied to transactions that do not meet certain qualifying criteria under the transaction plan.
transactionRate
number
The single payment processing event under the transaction plan.
bankerInformation
object
An object containing all details related to banker information.
7 properties
paymentModeCode
stringnull
The type of payment mode associated with a transaction under the transaction plan.
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
monerisGoPointOfSaleRetail
objectnull
An object containing the Moneris Go point of sale retail details.
1 property
agreementModelCode
stringnull
A code that identifies the specific type or model of agreement associated with the order or account.
minimumDisqualifiedTransactionMerchantDiscountRate
number
The minimum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.
manufacturer
stringnull
The name of the company that produces the terminal.
terminal
object
An object representing a payment terminal device to process transactions.
15 properties
1 required
merchantOrderId
integer
A unique identifier assigned by the merchant to track a specific customer order.
cableType
stringnull
Indicates the type of the cable included with the terminal device.
supplies
array
A list of supply items.
solutionDetails
object
An object containing the solutions details.
3 properties
2 required
monerisAdvance
objectnull
An object containing details related to Moneris Advance.
5 properties
cardAcquirer
stringnull
A string attribute representing the acquiring bank or institution.
installationType
stringnull
Specifies the method or environment of terminal installation.
kioskReference
stringnull
Identifies the specific kiosk associated with the terminal.
supply
object
An object containing all details related to a supply.
3 properties
2 required
maximumMerchantDiscountRate
number
The maximum merchant discount rate that applies under the transaction plan.
pinpadModel
stringnull
Specifies the model or type of the PIN pad component integrated with the terminal.
region
stringnull
Specify the geographical area, province or territory relevant to the operation.
userDetails
object
An object containing personal information about the user involved in the transaction.
3 properties
documentsStatus
objectnull
An object containing the documents status details.
2 properties
quantity
integer
Specifies the amount of goods currently available for a particular product.
integratedProduct
objectnull
An object containing details about the integrated product.
12 properties
wireless
objectnull
An object containing details about the wireless connectivity product.
2 properties
feeDetails
objectnull
An object containing the fees details
13 properties
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
transitNumber
stringnull
Attribute representing the five-digit branch number of a financial institution.
transactionPlanTier
stringnull
The level or band within the transaction plan.
assessmentPlans
array
A list of assessment items.
applicationDetails
objectnull
Details about the application
1 property
updatePartnerBankOrderRequest
object
An object containing all the Order payload partner bank details.
4 properties
3 required
amount
integer
Amount
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 Subscriptions API
#Terminal & Service Orders
Where this information came from
This is an independent, third-party profile of Moneris Terminal & Service Orders 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.