Moneris Merchant Onboarding API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Merchant Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 3 paths,
and defines 84 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.
signingOfficer
object
An object containing all details about the signing officer of the business.
9 properties
7 required
merchantSupplies
object
An object containing a list of supplies associated with the merchant.
6 properties
businessType
string
The category of the business.
deviceName
stringnull
The name of the device.
monthsOfOwnership
integer
An integer representing the number of months the merchant has been in ownership.
creditTransactionVolume
integer
A numeric value representing the total transaction volume generated through credit-based payments.
email
string
Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322
merchantInformation
object
An object containing all information about the merchant.
9 properties
8 required
interacTransactionVolume
integer
A numeric value representing the total transaction volume generated through Interac payments.
institutionNumber
string
The name or identifier of the financial institution.
addionalBankingAccountType
string
The type of the additional banking account.
bank
object
An object that contains information about the bank associated with the account or transaction.
4 properties
4 required
lastName
stringnull
Last name.
masterCardDebitTransactionVolume
integer
A numeric value representing the total transaction volume generated through MasterCard Debit payments.
merchant
object
An object containing the details of a merchant.
11 properties
1 required
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
businessSubCategory
stringnull
The sub-category of the business.
serviceDeliverToUSAvailable
boolean
A boolean value indicating whether the business is available for delivery to US.
first
stringnull
Pagination link pointing to the first page.
firstName
stringnull
First name.
businessDetails
object
An object containing key information about the business associated with the account or transaction.
24 properties
5 required
serviceCode
stringnull
The service code associated with the device.
operatingAsName
string
The trade name under which the merchant operates.
motoTransactionPercentage
number
The percentage of transactions processed through mail order / telephone order.
amexTransactionVolume
integer
A numeric value representing the total transaction volume generated through American Express payments.
serviceProvider
stringnull
The name or identifier of the service provider associated to the business.
parameterError
object
Request property or header related error.
4 properties
2 required
serviceDeliverToCanadaAvailable
boolean
A boolean value indicating whether the business is available for delivery to Canada.
error
object
Error response details.
7 properties
1 required
maximumTransactionVolume
integer
A numeric value that represents the highest expected transaction volume.
ecommerceTransactionPercentage
number
The percentage of transactions processed through e-commerce.
supplyType
stringnull
The type of supply associated with the device.
marketSegment
stringnull
Identifies the specific customer or business segment targeted by a product or service.
accountNumber
stringnull
Attribute that represent the unique identifier for a bank account.
unionPayTransactionVolume
integer
A numeric value representing the total transaction volume generated through UnionPay payments.
merchantSupply
object
An object containing all details related to a merchant supply.
9 properties
2 required
legalName
string
The registered name of the merchant.
pinpadType
stringnull
The type of pinpad associated with the device.
contactInformation
object
An object containing all the contact details.
3 properties
3 required
visaDebitTransactionVolume
integer
A numeric value representing the total transaction volume generated through Visa Debit payments.
settlementTime
stringnull
A timestamp indicating the time when a transaction is settled.
createMerchantRequest
Create a new merchant with the provided details.
settlementOption
string
The method for settling transactions.
visaTransactionVolume
integer
A numeric value representing the total transaction volume generated through Visa payments.
dropShipping
boolean
A boolean value indicating whether the business engages in drop shipping as part of its operations.
securityDetails
object
An object containing all details about the security details.
2 properties
2 required
merchantDetails
object
An object that contains key information about the merchant associated.
4 properties
3 required
masterCardTransactionVolume
integer
A numeric value representing the total transaction volume generated through MasterCard payments.
businessCategory
stringnull
The category of the business.
softwareVendors
array
A list of software vendors associated with the device.
next
stringnull
Pagination link pointing to the next page.
discoverTransactionVolume
integer
A numeric value representing the total transaction volume generated through Discover payments.
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."
yearsOfOwnership
integer
An integer representing the number of years the merchant has been in ownership.
supplyName
string
Indicates the name of the good available for fulfillment or distribution.
apiVersion
string
The endpoint's API Version. Must be provided through headers.
merchantType
stringnull
The category of the merchant's business.
cardReaderName
stringnull
The name of the card reader associated with the device.
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
directSellingPercentage
number
The percentage of transactions processed through direct selling.
riskLevel
stringnull
The risk level associated with the business.
self
stringnull
Pagination link pointing to the current page.
merchantCategoryCode
string
A four-digit code that classifies the type of business or service provided by the merchant, based on standard industry categories.
supply
object
An object containing all details related to a supply.
3 properties
2 required
averageTicketSize
integer
A numeric value representing the average transaction amount for the business.
phoneNumber
string
Phone number.
businessUrl
stringnull
The official website URL of the business.
offeredProductsAndServicesDescription
stringnull
A description of type of products and services offered by the business.
isSeasonalMerchant
boolean
A boolean value indicating whether the business operates seasonally.
merchantRiskRate
string
A score indicating the level of risk associated with the merchant's transactions.
last
stringnull
Pagination link pointing to the last page.
quantity
integer
Specifies the amount of goods currently available for a particular product.
previous
stringnull
Pagination link pointing to the previous page.
merchantPayload
object
An object containing the merchant payload details.
8 properties
5 required
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
transitNumber
stringnull
Attribute representing the five-digit branch number of a financial institution.
carriers
array
A list of carrier options available for the device.
bankingDetails
object
An object that contains the necessary banking information related to the account or transaction.
2 properties
1 required
chainId
stringnull
A unique identifier assigned to a specific organizational chain.
businessActivity
object
An object containing all details about the business activity.
1 property
1 required
additionalBankingAccount
object
An object that contains additional banking account information.
legalEntity
object
An object containing all details about the legal entity of the business.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Moneris publishes across the network.
