Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Refunds

Create Refund

This operation is used to create a Refund. For payment refunds, Payment Id is required while payment method is not required. For independent refunds, no payment Id is required, however payment method is required.

post/refunds

Request body

OR

Example request

{
  "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "multipleCompletion": {
    "amount": {
      "amount": 16000,
      "currency": "CAD"
    },
    "processedAt": "2019-07-30T06:43:40.252Z"
  },
  "idempotencyKey": "6q5w4e7r8t9y",
  "invoiceNumber": "1a2s3d45v6",
  "refundAmount": {
    "amount": 17500,
    "currency": "CAD"
  },
  "multiCurrencyPricing": {
    "multiCurrencyPricingOptIn": "OPT_IN",
    "multiCurrencyPricingRateLookupId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "amountDetails": {
    "surchargeAmount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "dynamicDescriptor": "moneris",
  "ipv4": "104.75.173.179",
  "ipv6": "2600:1401:2::8a",
  "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE",
  "reason": "Defective product"
}

Response

Refund operation result response

refundIdstring required

Unique Identification for the Refund

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.

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

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.

refundStatus'DECLINED' | 'DECLINED_RETRY' | 'PROCESSING' | 'SUCCEEDED' required

Refund Status description.

reasonstring nullable

Reason for the refund.

customDataCustomData nullable

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

Example response

{
  "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "payment": {
    "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
  },
  "orderId": "1q2w3e4r5t6t78",
  "merchantId": "0123456789101",
  "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"
  },
  "createdAt": "2019-07-30T06:43:40.252Z",
  "modifiedAt": "2019-07-30T06:43:40.252Z",
  "refundAmount": {
    "amount": 17500,
    "currency": "CAD"
  },
  "amountDetails": {
    "surchargeAmount": {
      "amount": 16000,
      "currency": "CAD"
    }
  },
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "refundStatus": "SUCCEEDED",
  "transactionDetails": {
    "isoResponseCode": "00",
    "responseCode": "001",
    "authorizationCode": "11223344",
    "message": "SUCCESS",
    "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE"
  },
  "reason": "Defective product",
  "credentialOnFileResponse": {
    "originalAmount": {
      "amount": 15000,
      "currency": "CAD"
    },
    "issuerId": "A"
  },
  "multiCurrencyPricingDetails": {
    "cardholderAmount": {
      "currency": "USD",
      "amount": 30000
    },
    "multiCurrencyPricingRate": 1.2345
  }
}