Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Payments

Create Payment

This operation is used to initiate a Payment.

post/payments

Request body

idempotencyKeystring required

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

orderIdstring nullable

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.

invoiceNumberstring nullable

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

customerIdstring nullable

The unique identifier of the customer.

customerReferencestring nullable

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

ecommerceIndicator'MAIL_TELEPHONE_ORDER_SINGLE' | 'MAIL_TELEPHONE_ORDER_RECURRING' | 'MAIL_TELEPHONE_ORDER_INSTALMENT' | 'MAIL_TELEPHONE_ORDER_UNKNOWN' | 'AUTHENTICATED_ECOMMERCE' | 'NON_AUTHENTICATED_ECOMMERCE' | 'SSL_MERCHANT'

Describes the category of e-commerce transaction being processed.

automaticCaptureboolean
  • 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.
incrementalAuthorizationboolean

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

customDataobject nullable

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

dynamicDescriptorstring nullable

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.

ipv4string ipv4 nullable

Internet Protocol version 4 (IPv4).

ipv6string ipv6 nullable

Internet Protocol version 6 (IPv6).

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "orderId": "1q2w3e4r5t6t78",
  "invoiceNumber": "1a2s3d45v6",
  "amount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "amountDetails": {
    "subTotalAmount": {
      "amount": 2000,
      "currency": "CAD"
    },
    "tipAmount": {
      "amount": 1200,
      "currency": "CAD"
    },
    "surchargeAmount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "convenienceFee": {
    "amount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "credentialOnFileInformation": {
      "paymentIndicator": "CUSTOMER_INITIATED",
      "paymentInformation": "FIRST",
      "issuerId": "123asd"
    }
  },
  "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE",
  "dynamicDescriptor": "moneris",
  "threeDSecureData": {
    "threeDSecureAuthenticationId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "installmentPlanInformation": {
    "planId": "130d93f9-8a5d-a78c-4741-14905057ce01",
    "planIdReference": "0000000063",
    "planTermsAndConditionsVersion": "1"
  },
  "multiCurrencyPricing": {
    "multiCurrencyPricingOptIn": "OPT_IN",
    "multiCurrencyPricingRateLookupId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "ipv4": "104.75.173.179",
  "ipv6": "2600:1401:2::8a"
}

Response

Payment operation created successfully.

paymentIdstring required

Unique Identification for the Payment

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

orderIdstring nullable

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.

invoiceNumberstring nullable

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

transactionDateTimestring date-time required

Indicates the date and time of the transaction.

createdAtstring date-time required

Time at which the object was created

modifiedAtstring date-time nullable

Time at which the object was modified

customerIdstring nullable

Unique Identification for the Customer

customerReferencestring nullable

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

paymentStatus'CANCELED' | 'DECLINED' | 'DECLINED_RETRY' | 'AUTHORIZED' | 'PROCESSING' | 'SUCCEEDED' | 'INCREMENTED' | 'PARTIALLY_COMPLETED' required

Payment Status description.

customDataCustomData nullable

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

Example response

{
  "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "orderId": "1q2w3e4r5t6t78",
  "invoiceNumber": "1a2s3d45v6",
  "transactionDateTime": "2019-07-30T06:43:40.252Z",
  "createdAt": "2019-07-30T06:43:40.252Z",
  "modifiedAt": "2019-07-30T06:43:40.252Z",
  "amount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "authorizedAmount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "capturableAmount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "amountDetails": {
    "subTotalAmount": {
      "amount": 2000,
      "currency": "CAD"
    },
    "tipAmount": {
      "amount": 1200,
      "currency": "CAD"
    },
    "surchargeAmount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "convenienceFeeDetails": {
    "status": "COMPLETED_SECOND_PURCHASE_TRANSACTION",
    "amount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantId": "0123456789101",
    "cardholderInformation": {
      "cardholderName": "John Doe",
      "companyName": "SP Ltd"
    },
    "contactDetails": {
      "phoneNumber": "+18663197450",
      "email": "moneris@moneris.com"
    },
    "billingAddress": {
      "unitNumber": "123A",
      "streetNumber": "3300",
      "streetName": "Bloor Street West",
      "city": "Toronto",
      "province": "ON",
      "postalCode": "M8X 2X2",
      "country": "CA"
    },
    "paymentMethodInformation": {
      "paymentMethodSource": "TEMPORARY_TOKEN",
      "cardInformation": {
        "bankIdentificationNumber": "123456",
        "lastFour": "1234",
        "expiryMonth": 1,
        "expiryYear": 2023,
        "cardBrand": "MASTERCARD",
        "cardType": "CREDIT",
        "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw",
        "issuer": "RBC"
      },
      "paymentAccountReference": "11112222333344445555666677778"
    },
    "createdAt": "2019-07-30T06:43:40.252Z",
    "modifiedAt": "2019-07-30T06:43:40.252Z"
  },
  "paymentStatus": "SUCCEEDED",
  "transactionDetails": {
    "isoResponseCode": "00",
    "responseCode": "001",
    "authorizationCode": "11223344",
    "message": "SUCCESS",
    "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE"
  },
  "verificationDetails": {
    "addressVerificationServiceResultCode": "FULL_MATCH",
    "cardSecurityCodeResultCode": "MATCH",
    "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED"
  },
  "credentialOnFileResponse": {
    "originalAmount": {
      "amount": 15000,
      "currency": "CAD"
    },
    "issuerId": "A"
  },
  "multiCurrencyPricingDetails": {
    "cardholderAmount": {
      "currency": "USD",
      "amount": 30000
    },
    "multiCurrencyPricingRate": 1.2345
  },
  "refundDetails": {
    "refunds": [
      {
        "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV",
        "href": "/refunds/ri0105ARZ3NDEKTSV4RRFFQ69G5FAV"
      }
    ],
    "refundedAmount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "subscription": {
    "subscriptionId": "si0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "href": "/subscriptions/rp0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "installmentPlanDetails": {
    "planId": "130d93f9-8a5d-a78c-4741-14905057ce01",
    "planIdReference": "0000000063",
    "planTermsAndConditionsVersion": "1",
    "planAcceptanceId": "56d58423-ea25-64e0-ddf3-1e1133549801",
    "planStatus": "ACCEPTED"
  },
  "incrementalAuthorizations": [
    {
      "amount": {
        "amount": 16000,
        "currency": "CAD"
      },
      "processedAt": "2019-07-30T06:43:40.252Z"
    }
  ],
  "multipleCompletions": [
    {
      "amount": {
        "amount": 16000,
        "currency": "CAD"
      },
      "processedAt": "2019-07-30T06:43:40.252Z"
    }
  ]
}