v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB

Payments

Retrieve Payment

Retrieve a payment by its payment Id

get/payments/{payment-id}

Response

The payment corresponding to the provided payment-id

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.

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"
    }
  ]
}