Create Order

post

https://api.sb.moneris.io/onboarding/merchants/{merchant-id}/orders

Submit an order payload to create an order for the merchant

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchant-id

string

required

length between 13 and 13

Thirteen character identification code.
Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

Body Params

Represents the payload for submitting an order.

idempotencyKey

string

required

length between 1 and 36

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."

marketSegment

string | null

enum

Identifies the specific customer or business segment targeted by a product or service.

representativeCode

string | null

A code that identifies the representative agent associated with the order.

userDetails

object

required

An object containing personal information about the user involved in the transaction.

applicablePromotions

array of strings

length ≤ 10

A list of promotion codes applicable to the order.

applicablePromotions

feeDetails

object | null

An object containing the fees details

applicationDetails

object | null

required

Details about the application

agreementModelInformation

object | null

An object containing the agreement model info details.

valueAddedServices

array of strings

length ≤ 18

A list of value-added services associated with the order.

documentsStatus

object | null

An object containing the documents status details.

confirmation

object | null

An object containing the confirmation details.

supplies

array of objects

length ≤ 116

A list of supply items.

supplies

productDetails

object

required

An object containing all details related to a product.

isAutoAdjudicationRequired

boolean

A boolean flag indicating whether the auto adjudication process is required.

isExpeditedOrder

boolean

A boolean flag indicating whether an order is being processed as a rush or expedited order.

cardPlanDetails

object | null

An object containing all the card plans details.

solutions

array of objects

length ≤ 5

A list of solution items.

solutions

deliveryAddress

object | null

a (natural or legal) person that gets addressed

orderCreatedBy

string | null

The individual responsible for creating the order.

Headers

Api-Version

string

required

Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

X-Correlation-Id

string

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist.
Merchants are to echo back the value with every request that is part of the call flow."

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Successful response corresponding to the provided payload

400Bad Request.

401Not authorized. The user does not have a valid API Key or Access Token.

403Forbidden. The user does not have permission to access the requested resource.

404Not Found.

409Request could not be completed due to a conflict with resource state or existing idempotency key.

422The API cannot complete the requested action due to semantic or business validation errors.

429Too Many Requests

500Unexpected error.

503Service Temporarily Unavailable