Moneris Refunds API is one of 15 APIs that Moneris publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Refunds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 2 paths,
and defines 95 schemas.
It is described by OpenAPI 3.2.0, at version 2.6.1.
Requests are made against 2 base URLs: https://api.sb.moneris.io, https://api.moneris.io.
The identity and technical contract details declared by the specification.
expiryYear
integer
Displays the card expiration year. Accepted format: YYYY
paymentMethodCard
Credit/Debit/Gift Card payment method details.
2 required
storeApplePayDecryptedWalletRequest
createRefundRequestBase
object
13 properties
2 required
cardholderName
string
Cardholder name
paymentMethodPermanentToken
A Permanent Token is issued by Moneris to the merchant and represents the card details. This option is used for legacy purposes.
2 required
createMatchingRefundRequest
Matching Refund
companyName
stringnull
Identifies the associated company name
cardSecurityCode
string
CVD value located on credit card. The CVD value (supplied by the cardholder) must only be passed to the payment gateway. Under no circumstances may it be store…
storePaymentMethodCardRequest
cardBrand
stringnull
Displays the card brand name associated with the card type.
message
stringnull
Displays response description returned from issuing institution. NOTE: This message should not be displayed on any cardholder facing materials. For receipt pur…
refundStatus
string
Refund Status description.
money
object
Monetary amount. Note: The value must be in cents. Therefore $10.59 must be sent as 1059.
2 properties
2 required
paymentMethod
object
Payment method response object
9 properties
4 required
first
stringnull
Pagination link pointing to the first page.
card
object
Card details
4 properties
4 required
paymentId
string
Unique Identification for the Payment
refundAmount
object
Refund amount for the transaction. Note: The value must be in cents. Therefore $10.59 must be sent as 1059
2 properties
2 required
storePaymentMethodIdRequest
token
string
Created when a temporary token is created and returned. This acts as a unique profile identifier, and is a required value for temporary token transactions.
ecommerceIndicator
string
The ecommerce indicator (ECI) specifies the level of security that was used to obtain the cardholder's payment data. It is sent by the merchant and returned by…
createIndependentRefundRequest
Independent Refund
storeGooglePayEncryptedWalletRequest
ipv6
stringnull
Internet Protocol version 6 (IPv6).
cardInformation
object
Information about the card being used for the transaction
8 properties
credentialOnFileInformation
object
Contains fields related to the Credential on File (CoF)
4 properties
2 required
googlePayDecryptedWallet
Google Pay wallet details after decrypting the token.
1 required
walletCryptogram
string
Token cryptogram or encoded Base64 for Interac Wallets.
paymentAccountReference
stringnull
Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism.
storeGooglePayDecryptedWalletRequest
parameterError
object
Request property or header related error.
4 properties
2 required
createdAt
string
Time at which the object was created
walletEcommerceIndicator
stringnull
ECI Indicator as provided by the Wallet.
error
object
Error response details.
7 properties
1 required
googlePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
paymentMethodRequestSource
string
The source of Payment Method being used. It can be: - The Id of a Payment Method already created. - Permanent Token. - Temporary Token. - Card. - E-Wallet.
storePaymentMethodRequest
Used to collect payment data needed to execute the transaction. Can also be used to collect and save customer payment instruments on file.
1 required
paymentMethodId
string
Unique Identifier of the payment method.
multiCurrencyPricingOptIn
string
Indicates if Multi-Currency Pricing is to be used for this transaction.
storePermanentToken
string
Store this payment method created through this payment for future use. - CARDHOLDERINITIATED: Payment method to be stored and can only re-used with cardholder'…
ipv4
stringnull
Internet Protocol version 4 (IPv4).
storePaymentMethodTemporaryTokenRequest
authorizationCode
stringnull
Contains a value generated by the authorizer for an approved financial transactions. This operates as the authorizing host's transaction identification.
paymentMethodWithId
object
Use existing unique payment method identifier.
2 properties
2 required
storePaymentMethodPermanentTokenRequest
storePaymentMethod
string
Store this payment method created through this payment for future use. - DONOTSTORE: Payment method will not be stored. - CARDHOLDERINITIATED: Payment method t…
storeApplePayEncryptedWalletRequest
cardNumber
string
Identifies the customer's credit or debit card number (Primary Account Number).
googlePayDecryptedCardDetails
object
The payment credential itself. The format of this object is determined by the paymentMethod
6 properties
3 required
cardFingerprint
stringnull
Unique card identifier. Fingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple…
cardholderInformation
objectnull
Information about the holder of the card.
2 properties
1 required
originalAmount
objectnull
Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059
2 properties
2 required
dataType
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions and is mandatory for INTERAC® e-Commerce Ap…
walletIndicator
string
Only available to Canada integrations. Applies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions.…
next
stringnull
Pagination link pointing to the next page.
dynamicDescriptor
stringnull
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 ty…
refundId
string
Unique Identification for the Refund
idempotencyKey
string
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."
credentialOnFileResponse
objectnull
Contains fields related to the Credential on File (CoF)
2 properties
paymentMethodRequestBase
object
Payment Method details. Note: If defined, this will result in the creation of Payment Method as defined in the Payment Method API.
5 properties
1 required
refund
object
17 properties
7 required
iso
string
Represents the Moneris response code for the equivalent International Organization for Standardization (ISO) response code.
paymentMethodTemporaryToken
A Temporary Token is issued by Moneris to the merchant and represents the card details. Please review the Hosted Tokenization feature documentation to learn ho…
2 required
apiVersion
string
The endpoint's API Version. Must be provided through headers.
expiryMonth
integer
Card expiration month. Format must be MM
applePayDecryptedWallet
Apple Pay wallet details after decrypting the token.
1 required
refundList
object
6 properties
1 required
statusDetails
object
Additional details about the transaction outcome.
6 properties
3 required
currency
string
Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO4217
paymentInformation
string
Describes whether the transaction is the first or subsequent in the series
responseCode
string
"Details Transaction Response Codes: - 50: Transaction declined NULL: Transaction not sent for authorization For a complete list of definitions, refer to the R…
issuerId
stringnull
Displays a unique identifier for the card holder's stored credentials. This information is returned from the card brand when processing a Credential on File tr…
applePayEncryptedWallet
Apple Pay encrypted wallet details.
1 required
modifiedAt
stringnull
Time at which the object was modified
dateTime
string
Date & Time
customData
objectnull
Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
self
stringnull
Pagination link pointing to the current page.
deviceManufacturerIdentifier
stringnull
Hex-encoded device manufacturer identifier
orderId
stringnull
Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transacti…
paymentReference
objectnull
Payment reference. Can be expanded into full payment details using the expand query parameter.
2 properties
1 required
paymentIndicator
string
Indicates the current or intended use of the credentials - UNSCHEDULEDCREDENTIALONFILE: unscheduled Credential on File (first transactions only) - RECURRING: r…
contactDetails
objectnull
Contact details
2 properties
last
stringnull
Pagination link pointing to the last page.
cardPaymentMethodInformation
object
Details about the card used in the payment method.
5 properties
4 required
multiCurrencyPricingDetails
objectnull
Exchange rate for use in a subsequent MCP financial transaction
3 properties
3 required
multiCurrencyPricingTransactionRequest
objectnull
Multi-Currency Pricing (MCP) Object
2 properties
1 required
previous
stringnull
Pagination link pointing to the previous page.
processedAt
string
Time at which the object was processed
issuer
stringnull
Card issuer.
merchantId
string
Thirteen character long identification provided to merchants by Moneris.
invoiceNumber
stringnull
Submits a unique value to identify a transaction that is logged by Moneris Solutions.
paymentUri
stringnull
Payment Reference URL
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Moneris publishes across the network.
