GuidesAPI ReferenceChangelog
Log In
API Reference
  1. Moneris API
  2. Payments

Create Payment

post
https://api.sb.moneris.io/payments

This operation is used to initiate a Payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body, used to initiate a payment

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

string | null
^[a-zA-Z0-9-_]+$

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

string | null

Submits a unique value to identify a transaction that is logged by Moneris Solutions.

amount
object
required

This amount includes the surcharge fee.

amountDetails
object | null

Contains information pertaining to the subtotal, tip, and surcharge amounts of a Payment

convenienceFee
object | null

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 an alternative payment channel.

string | null
^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

The unique identifier of the customer.

string | null

Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.

paymentMethod
required

Used to collect payment data needed to execute the transaction.
Can also be used to collect and save customer payment instruments on file.

string
enum
Defaults to SSL_MERCHANT

Describes the category of e-commerce transaction being processed.

Allowed:
boolean
Defaults to true
  • true: (Default) will prompt Moneris to capture the payment when it is authorized. This performs a Purchase transaction.
  • false: will prompt Moneris to place a hold on the funds when the payment is authorized. This performs a Pre-Authorization transaction.
boolean
Defaults to false

This flag is used for processing the Pre-Authorization transaction as an Incremental Authorization transaction.

customData
object | null

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

string | null

Merchant defined description sent on a per-transaction basis that will appear on the credit card statement.

Dependent on the card Issuer, the statement will typically show the dynamic descriptor appended to the merchant's existing business name separated by the '/' character.

Note: The combined length of the merchant's business name, forward slash '/' character, and the dynamic descriptor may not exceed 22 characters.

threeDSecureData

Data related to 3-D Secure

installmentPlanInformation
object | null

Installment plan details, if an installment plan is selected

multiCurrencyPricing
object | null

Multi-Currency Pricing (MCP) Object

string | null

Internet Protocol version 4 (IPv4).

string | null

Internet Protocol version 6 (IPv6).

Headers
string
required
Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
*/*

Updated 3 months ago

Did this page help you?