--- updatedAt: 2026-08-14T03:36:14.000Z agentTools: projectIndex: https://developer.moneris.com/moneris-api/llms.txt --- # Update Payment Method Information Updates specific fields of a payment method identified by its Id. This API supports updates for both stored and not stored payment methods. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "version": "2.15.1", "title": "Moneris API", "description": "Moneris API Platform\n\n\n[\"Run](https://god.gw.postman.com/run-collection/25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8?action=collection%2Ffork&collection-url=entityId%3D25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8%26entityType%3Dcollection%26workspaceId%3D5d2a9a0f-57a7-441c-b2af-fe6315e80a08)", "termsOfService": "https://www.moneris.com/en/legal/terms-of-use", "contact": { "url": "https://api-developer.moneris.com", "email": "api@moneris.com" }, "license": { "name": "Moneris", "url": "https://developer.moneris.com/Agreements/Terms%20of%20Use" }, "x-audience": "external-public" }, "servers": [ { "url": "https://api.sb.moneris.io", "description": "Sandbox server (uses test data)", "x-internal": false }, { "url": "https://api.moneris.io", "description": "Production server (uses live data)", "x-internal": false } ], "tags": [ { "name": "Payment Methods", "description": "Create and Manage payment methods" } ], "paths": { "/payment-methods/{payment-method-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentMethodId" }, { "$ref": "#/components/parameters/merchantId" } ], "patch": { "summary": "Update Payment Method Information", "description": "Updates specific fields of a payment method identified by its Id. \nThis API supports updates for both stored and not stored payment methods.\n", "operationId": "updatePaymentMethodInformation", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/updatePaymentMethodInformationRequest" }, "examples": { "card": { "$ref": "#/components/examples/updatePaymentMethodInformationRequest" } } } } }, "responses": { "200": { "$ref": "#/components/responses/paymentMethodUpdateSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/paymentMethodNotFoundResponse" }, "409": { "$ref": "#/components/responses/concurrencyConflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "An API key is a token that a client provides when making API calls.\n\nAPI keys are supposed to be a secret that only the client and server know about.\n" }, "OAuth2": { "type": "oauth2", "description": "OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server.\n\nOAuth relies on authentication scenarios, that allows the resource owner (user) to share the protected content from the server, hosting the resource, without sharing their credentials. For that purpose, an OAuth 2.0 server issues access tokens that the client applications can use to access protected resources on behalf of the resource owner.\n\nMoneris recommends the use of OAuth 2.0 as it provides fine grained authorization levels.\n", "flows": { "clientCredentials": { "tokenUrl": "/oauth2/token", "scopes": { "payment.read": "Grants read access to payment related APIs", "payment.write": "Grants read & write access to payment related APIs", "refund.read": "Grants read access to refunds", "refund.write": "Grants read & write access to refunds", "customer.read": "Grants read access to customer data", "customer.write": "Grants read & write access to customer data", "kount.read": "Grants read access to Kount inquiries", "kount.write": "Grants read & write access to Kount inquiries", "onboarding.merchant.read": "Grants read access to merchant onboarding related APIs", "onboarding.merchant.write": "Grants read & write access to merchant onboarding related APIs", "onboarding.order.read": "Grants read access to onboarding orders related APIs", "onboarding.order.write": "Grants read & write access to onboarding orders related APIs", "dispute.read": "Grants read access to disputes", "dispute.write": "Grants read & write access to disputes", "payout.write": "Grants read & write access to payouts", "partner.account.write": "Grants read & write access to partner merchant accounts" } } } } }, "schemas": { "apiVersion": { "description": "The endpoint's API Version. Must be provided through headers.\n", "type": "string", "example": "2026-08-14", "default": "2026-08-14" }, "merchantId": { "type": "string", "description": "Thirteen character long identification provided to merchants by Moneris. \n", "minLength": 13, "maxLength": 13, "example": "0123456789101" }, "resourceId": { "type": "string", "description": "Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "paymentMethodId": { "type": "string", "description": "Unique Identifier of the payment method.", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "cardholderName": { "type": "string", "description": "Cardholder name", "minLength": 1, "maxLength": 60, "example": "John Doe" }, "firstName": { "type": "string", "description": "First name.", "minLength": 1, "maxLength": 30, "example": "John", "nullable": true }, "middleName": { "type": "string", "description": "Customer's middle name.", "minLength": 1, "maxLength": 30, "example": "J.", "nullable": true }, "lastName": { "type": "string", "description": "Last name.", "minLength": 1, "maxLength": 30, "example": "Doe", "nullable": true }, "cardholderNameDetails": { "type": "object", "description": "Cardholder name details", "nullable": true, "properties": { "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" } } }, "companyName": { "type": "string", "description": "Identifies the associated company name", "minLength": 1, "maxLength": 50, "example": "SP Ltd", "nullable": true }, "cardholderInformation": { "type": "object", "description": "Information about the holder of the card.", "nullable": true, "properties": { "cardholderName": { "$ref": "#/components/schemas/cardholderName" }, "cardholderNameDetails": { "$ref": "#/components/schemas/cardholderNameDetails" }, "companyName": { "$ref": "#/components/schemas/companyName" } }, "required": [ "cardholderName" ] }, "contactDetails": { "type": "object", "description": "Contact details", "nullable": true, "properties": { "phoneNumber": { "nullable": true, "type": "string", "description": "Phone number.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "email": { "nullable": true, "type": "string", "format": "email", "description": "Contains the customer's email address.\n\nFor standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322\n", "minLength": 1, "maxLength": 320, "example": "moneris@moneris.com" } }, "example": { "phoneNumber": "+18663197450", "email": "moneris@moneris.com" } }, "expiryMonth": { "type": "integer", "format": "int32", "description": "Card expiration month. Format must be MM", "minimum": 1, "maximum": 12, "example": 1 }, "expiryYear": { "type": "integer", "format": "int32", "description": "Displays the card expiration year. Accepted format: YYYY", "minimum": 2022, "maximum": 9999, "example": 2023 }, "cardBrand": { "type": "string", "description": "Displays the card brand name associated with the card type.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "JCB", "DISCOVER", "INTERAC", "UNIONPAY", "GIFT_MONERIS", "GIFT_DATACANDY", "GIFT_GIVEX", null ], "nullable": true, "example": "MASTERCARD" }, "cardFingerprint": { "type": "string", "description": "Unique card identifier. \n\nFingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple payments methods are attached to the same underlying card, and assists merchants identify individual customers across various channels; i.e. loyalty programs.\n", "maxLength": 255, "example": "1Q2W3E4r5t6rfwewerwewrrw", "nullable": true }, "issuer": { "type": "string", "description": "Card issuer.", "minLength": 1, "maxLength": 100, "example": "RBC", "nullable": true }, "cardInformation": { "type": "object", "description": "Information about the card being used for the transaction", "properties": { "bankIdentificationNumber": { "nullable": true, "type": "string", "description": "**BIN**: Bank Identification Number \n\nConsists of the first six to eight digits of the Primary Account Number (PAN) and identifies the relevant payment network and the specific payment issuing institution.\n", "minLength": 6, "maxLength": 8, "example": "123456" }, "lastFour": { "nullable": true, "type": "string", "description": "Last 4 digits of the card.", "minLength": 4, "maxLength": 4, "example": "1234" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "cardBrand": { "$ref": "#/components/schemas/cardBrand" }, "cardType": { "nullable": true, "type": "string", "description": "Specifies the intended card use; i.e. debit or credit.", "enum": [ "CREDIT", "DEBIT", "DOMESTIC_DEBIT", "PREPAID_RELOADABLE", "PREPAID_NON_RELOADABLE", "UNKNOWN", "GIFT", "LOYALTY", "FLEET", "CORPORATE" ], "example": "CREDIT" }, "cardFingerprint": { "$ref": "#/components/schemas/cardFingerprint" }, "issuer": { "$ref": "#/components/schemas/issuer" } } }, "paymentAccountReference": { "type": "string", "nullable": true, "description": "Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism.\n", "minLength": 1, "maxLength": 29, "example": "11112222333344445555666677778" }, "storePaymentMethod": { "description": "Store this payment method created through this payment for future use. \n- DO_NOT_STORE: Payment method will not be stored.\n- CARDHOLDER_INITIATED: Payment method to be stored and can only re-used with cardholder's consent. Limited to store, pre-authorisation, and card validations.\"\n- MERCHANT_INITIATED: Payment method to be stored and can be reused without the cardholder's consent. For example, subscriptions.\n", "type": "string", "default": "DO_NOT_STORE", "enum": [ "DO_NOT_STORE", "CARDHOLDER_INITIATED", "MERCHANT_INITIATED" ] }, "paymentMethodInformationBase": { "description": "Payment Method details.\n", "type": "object", "properties": { "paymentMethodType": { "type": "string", "description": "The type of Payment Method being used. It can be:\n - Card.\n - KONEK.\n", "enum": [ "CARD", "KONEK" ], "example": "CARD" }, "paymentMethodSource": { "type": "string", "description": "The source of Payment Method being used. It can be:\n - The Id of a Payment Method already created.\n - Permanent Token.\n - Temporary Token.\n - Card.\n - E-Wallet.\n - KONEK.\n", "enum": [ "CARD", "TEMPORARY_TOKEN", "PERMANENT_TOKEN", "APPLE_PAY_ENCRYPTED", "APPLE_PAY_DECRYPTED", "GOOGLE_PAY_ENCRYPTED", "GOOGLE_PAY_DECRYPTED", "KONEK" ], "example": "TEMPORARY_TOKEN" }, "paymentAccountReference": { "$ref": "#/components/schemas/paymentAccountReference" }, "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" } }, "required": [ "paymentMethodType", "paymentMethodSource", "storePaymentMethod" ] }, "paymentMethodInformationCard": { "title": "Card Payment Method Information", "description": "Details about the card used in the payment method.", "type": "object", "allOf": [ { "type": "object", "properties": { "cardInformation": { "$ref": "#/components/schemas/cardInformation" } }, "required": [ "cardInformation" ] }, { "$ref": "#/components/schemas/paymentMethodInformationBase" } ], "required": [ "paymentMethodType" ] }, "paymentConsentId": { "type": "string", "description": "Unique identifier of the Payment Consent within KONEK. Assigned by KONEK.", "maxLength": 36, "example": "ada78940-643e-4d70-be14-3bbb36992095" }, "transactionReference": { "type": "string", "description": "A unique reference value for the transaction data", "maxLength": 36 }, "accountType": { "type": "string", "description": "The type of account for the payment", "enum": [ "BANK_ACCOUNT_SAVINGS", "BANK_ACCOUNT_CHEQUING", "BANK_ACCOUNT_LINE_OF_CREDIT", "VISA_CREDIT", "VISA_DEBIT", "MASTERCARD_CREDIT", "MASTERCARD_DEBIT", "AMEX_CREDIT" ], "example": "BANK_ACCOUNT_SAVINGS" }, "amount": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 999999999, "example": 10000, "description": "Amount" }, "currency": { "type": "string", "description": "Provides the three letter currency code according the ISO 4217 standard. \n\nFor a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217\n", "minLength": 3, "maxLength": 4, "example": "CAD", "format": "iso-4217" }, "transactionData": { "title": "transactionData", "description": "Transaction data", "type": "object", "properties": { "paymentToken": { "type": "string", "description": "The payment token required for payment authorization request. This can be a Token PAN for Cards or Interac Payment Token for ABP.", "maxLength": 19, "example": 1234007123456789000 }, "tokenExpiry": { "type": "string", "description": "The token expiry date in the format MMYY", "maxLength": 4, "example": 1220 }, "cryptogram": { "type": "string", "description": "The payment cryptogram to use with the token for a payment authorization request. Presence of cryptogram depends on the `OrderItemPaymentType` and the scheme specified in `paymentMethod`. \nThis field contains Amex DSCS if `paymentMethod = AMEX_CREDIT`", "maxLength": 256, "nullable": true }, "cryptogramExpiry": { "type": "string", "description": "Cryptogram expiry date in ISO 8601", "format": "date-time", "nullable": true, "example": "2021-09-27T17:06:09Z" }, "consentId": { "$ref": "#/components/schemas/paymentConsentId" }, "transactionReference": { "$ref": "#/components/schemas/transactionReference" }, "konekPaymentMethod": { "$ref": "#/components/schemas/accountType" }, "amount": { "description": "Amount to be used for the payment transaction, copied from the request from merchant", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "konekPaymentType": { "description": "Transaction type, copied from the request from merchant", "nullable": true, "type": "string", "enum": [ "SINGLE", "SPLIT", "RECURRING" ], "example": "SINGLE" } }, "required": [ "paymentToken", "tokenExpiry", "consentId", "transactionReference", "konekPaymentMethod", "amount" ] }, "transactionTokenData": { "title": "transactionTokenData", "description": "Combines token PAN last digits and transaction data for enhanced payment token information.", "allOf": [ { "$ref": "#/components/schemas/transactionData" }, { "type": "object", "properties": { "tokenPrimaryAccountNumberLastDigits": { "nullable": true, "type": "string", "description": "Last 4 digits of token PAN", "maxLength": 4, "example": "3579" } } } ] }, "paymentMethodInformationKonek": { "title": "KONEK Payment Method Information", "description": "KONEK Payment Method Information", "type": "object", "allOf": [ { "type": "object", "properties": { "konekPaymentMethodInformation": { "$ref": "#/components/schemas/transactionTokenData" } }, "required": [ "konekPaymentMethodInformation" ] }, { "$ref": "#/components/schemas/paymentMethodInformationBase" } ], "required": [ "paymentMethodType" ] }, "paymentMethodInformation": { "title": "paymentMethodInformation", "description": "Used to collect payment data needed to execute the transaction. Can also be used to collect and save customer payment instruments on file. \n", "oneOf": [ { "$ref": "#/components/schemas/paymentMethodInformationCard" }, { "$ref": "#/components/schemas/paymentMethodInformationKonek" } ], "discriminator": { "propertyName": "paymentMethodType", "mapping": { "CARD": "#/components/schemas/paymentMethodInformationCard", "KONEK": "#/components/schemas/paymentMethodInformationKonek" } }, "required": [ "paymentMethodType" ] }, "createdAt": { "description": "Time at which the object was created", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "modifiedAt": { "nullable": true, "description": "Time at which the object was modified", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "customData": { "description": "Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxProperties": 10, "nullable": true }, "paymentMethod": { "title": "paymentMethod", "description": "Payment method response object", "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/paymentMethodId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "cardholderInformation": { "$ref": "#/components/schemas/cardholderInformation" }, "contactDetails": { "$ref": "#/components/schemas/contactDetails" }, "billingAddress": { "nullable": true, "type": "object", "description": "The postal address including street, town/city, province, and postal code.\nOptionally an unit number can be provided.\n", "properties": { "unitNumber": { "nullable": true, "type": "string", "description": "Unit number", "minLength": 1, "maxLength": 19, "example": "123A" }, "streetNumber": { "nullable": true, "type": "string", "description": "Street number", "minLength": 1, "maxLength": 19, "example": "3300" }, "streetName": { "nullable": true, "type": "string", "description": "Street name", "minLength": 1, "maxLength": 100, "example": "Bloor" }, "city": { "nullable": true, "type": "string", "description": "Identifies the city.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "province": { "nullable": true, "type": "string", "description": "Province or state ISO 3166-2 code ", "minLength": 1, "maxLength": 3, "format": "iso-3166-2", "example": "ON" }, "postalCode": { "nullable": true, "type": "string", "description": "Postal or zip code", "minLength": 1, "maxLength": 30, "example": "M8X 2X2" }, "country": { "nullable": true, "type": "string", "description": "Provides the two letter country code according the ISO 3166-1 alpha-2 standard. \nFor a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.\n", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" } }, "example": { "unitNumber": "123A", "streetNumber": "3300", "streetName": "Bloor Street West", "city": "Toronto", "province": "ON", "postalCode": "M8X 2X2", "country": "CA" } }, "paymentMethodInformation": { "$ref": "#/components/schemas/paymentMethodInformation" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "paymentMethodId", "merchantId", "paymentMethodInformation", "createdAt" ] }, "parameterError": { "title": "Parameter error", "description": "Request property or header related error.", "type": "object", "properties": { "parameterName": { "type": "string", "description": "Property or header name. Can contain nested path separated by '.'", "example": "address.postalCode" }, "parameterValue": { "type": "string", "nullable": true, "description": "Property or header value string representation.", "example": "MAP3J8" }, "reasonCode": { "type": "string", "description": "Reason that triggered the error.", "enum": [ "INVALID_FORMAT", "REQUIRED_FIELD", "INVALID_VALUE" ], "example": "INVALID_FORMAT" }, "errorMessage": { "type": "string", "description": "Human readable description of the error.", "nullable": true, "example": "String 'MAP3J8' does not match the postal code pattern." } }, "required": [ "parameterName", "reasonCode" ] }, "error": { "description": "Error response details.", "properties": { "type": { "description": "A URI reference that identifies the problem type. Ideally it should be a stable URL to the documentation of the details about this type of error but it also can be a URN. If nothing can be provided, a \"about:blank\" value is returned.\n", "type": "string", "format": "uri", "example": "https://api-developer.moneris.com/responsehandling" }, "title": { "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization\n", "type": "string", "example": "INSUFFICIENT_FUNDS", "nullable": true }, "status": { "description": "it conveys the HTTP status code used for the convenience of the consumer.\n", "type": "integer", "format": "int32", "minimum": 100, "maximum": 505, "nullable": true }, "detail": { "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.\n", "type": "string", "example": "Funds are insufficient to execute the operation.", "nullable": true }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. Typically, this resolves to a resource that might include more details about the problem.\n", "type": "string", "example": "/payments/12f3e0a8-1d68-2b86-dd30-4ca51bb66e10", "format": "uri-reference", "nullable": true }, "category": { "description": "The type of error returned. \n - `API_ERROR`: This occurs due to an intermittent issue. \n - `IDEMPOTENCY_ERROR`: The idempotency key has already been used.\n - `INVALID_REQUEST_ERROR`: The data provided in the request is invalid.\n - `DECLINED_ERROR`: Transaction was declined by the issuer.\n - `UNAUTHORIZED_ERROR`: Caller not authenticated, or not allowed to execute the current operation.\n - `INTERNAL_SERVER_ERROR`: An internal issue with our servers has occured.\n", "enum": [ "API_ERROR", "IDEMPOTENCY_ERROR", "INVALID_REQUEST_ERROR", "DECLINED_ERROR", "UNAUTHORIZED_ERROR", "INTERNAL_SERVER_ERROR", null ], "type": "string", "nullable": true, "example": "DECLINED_ERROR" }, "errors": { "type": "array", "description": "List of validation errors when error category is INVALID_REQUEST_ERROR.", "items": { "type": "object", "$ref": "#/components/schemas/parameterError" }, "example": [ { "parameterName": "address.postalCode", "parameterValue": "MAP3J8", "errorMessage": "address.Postal code does not match regular expression", "reasonCode": "INVALID_FORMAT" } ] } }, "title": "API Error", "type": "object", "required": [ "type" ] }, "cardNumber": { "type": "string", "description": "Identifies the customer's credit or debit card number (Primary Account Number).", "pattern": "^[0-9]{13,19}$", "example": "4242424242424242" }, "address": { "type": "object", "description": "The postal address including street, town/city, province, and postal code.\nOptionally an unit number can be provided.\n", "properties": { "unitNumber": { "nullable": true, "type": "string", "description": "Unit number", "minLength": 1, "maxLength": 19, "example": "123A" }, "streetNumber": { "nullable": true, "type": "string", "description": "Street number", "minLength": 1, "maxLength": 19, "example": "3300" }, "streetName": { "nullable": true, "type": "string", "description": "Street name", "minLength": 1, "maxLength": 100, "example": "Bloor" }, "city": { "nullable": true, "type": "string", "description": "Identifies the city.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "province": { "nullable": true, "type": "string", "description": "Province or state ISO 3166-2 code ", "minLength": 1, "maxLength": 3, "format": "iso-3166-2", "example": "ON" }, "postalCode": { "nullable": true, "type": "string", "description": "Postal or zip code", "minLength": 1, "maxLength": 30, "example": "M8X 2X2" }, "country": { "nullable": true, "type": "string", "description": "Provides the two letter country code according the ISO 3166-1 alpha-2 standard. \nFor a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.\n", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" } }, "example": { "unitNumber": "123A", "streetNumber": "3300", "streetName": "Bloor Street West", "city": "Toronto", "province": "ON", "postalCode": "M8X 2X2", "country": "CA" } }, "paymentIndicator": { "type": "string", "description": "Indicates the current or intended use of the credentials\n- **UNSCHEDULED_CREDENTIAL_ON_FILE**: unscheduled Credential on File (first transactions only)\n- **RECURRING**: recurring transaction\n- **MERCHANT_INITIATED**: unscheduled merchant-initiated transaction\n- **VARIABLE_RECURRING**: recurring variable payment transaction\n- **CUSTOMER_INITIATED**: unscheduled customer-initiated transaction\n", "enum": [ "UNSCHEDULED_CREDENTIAL_ON_FILE", "RECURRING", "MERCHANT_INITIATED", "VARIABLE_RECURRING", "CUSTOMER_INITIATED" ], "example": "UNSCHEDULED_CREDENTIAL_ON_FILE" }, "paymentInformation": { "type": "string", "description": "Describes whether the transaction is the first or subsequent in the series", "enum": [ "FIRST", "SUBSEQUENT" ], "example": "FIRST" }, "issuerId": { "type": "string", "description": "Displays a unique identifier for the card holder's stored credentials. \n\nThis information is returned from the card brand when processing a Credential on File transaction.\n", "minLength": 1, "maxLength": 15, "example": "A", "nullable": true }, "updatePaymentMethodInformationRequest": { "title": "updatePaymentMethodInformationRequest", "description": "Used to update payment data of an existing payment method.\n", "type": "object", "properties": { "cardholderInformation": { "type": "object", "description": "Information about the holder of the card.", "properties": { "cardholderName": { "$ref": "#/components/schemas/cardholderName" }, "cardholderNameDetails": { "$ref": "#/components/schemas/cardholderNameDetails" }, "companyName": { "$ref": "#/components/schemas/companyName" } } }, "contactDetails": { "$ref": "#/components/schemas/contactDetails" }, "billingAddress": { "$ref": "#/components/schemas/address" }, "credentialOnFileInformation": { "description": "Contains fields related to the Credential on File (CoF) ", "properties": { "paymentIndicator": { "$ref": "#/components/schemas/paymentIndicator" }, "paymentInformation": { "$ref": "#/components/schemas/paymentInformation" }, "issuerId": { "$ref": "#/components/schemas/issuerId" } }, "required": [ "issuerId" ] }, "card": { "type": "object", "properties": { "cardNumber": { "$ref": "#/components/schemas/cardNumber" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "cardSecurityCode": { "type": "string", "pattern": "[0-9]*", "description": "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 stored for subsequent use or displayed as part of the receipt information.\n\nNote: The CVD value is not supported for updating a stored payment method.\n", "minLength": 3, "maxLength": 4, "example": "123" } }, "required": [ "cardNumber", "expiryMonth", "expiryYear" ] } } } }, "parameters": { "apiVersion": { "in": "header", "name": "Api-Version", "required": true, "example": "2024-09-17", "description": "The endpoint's API Version. \n\nMust be provided through the headers section. \n", "schema": { "$ref": "#/components/schemas/apiVersion" } }, "correlationId": { "in": "header", "name": "X-Correlation-Id", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4", "description": "Correlates a series of requests within the same flow.\n\nNote: This ID is generated by Moneris with every request or response, if it doesn't exist. \nMerchants are to echo back the value with every request that is part of the call flow.\"\n", "required": false, "schema": { "type": "string", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4" } }, "merchantId": { "in": "header", "name": "X-Merchant-Id", "example": "0123456789101", "description": "Thirteen character identification code. \n\nNote: This code is provided by Moneris and is required to identify the Merchant executing the transaction.\n", "required": true, "schema": { "$ref": "#/components/schemas/merchantId" } }, "paymentMethodId": { "name": "payment-method-id", "in": "path", "description": "Payment Method ID", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } } }, "headers": { "apiVersion": { "description": "The endpoint's API Version.", "example": "2026-08-14", "schema": { "type": "string" } }, "correlationId": { "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4", "description": "Correlates a series of requests within the same flow. \n\nNote: This ID is generated by Moneris with every request or response, if it doesn't exist, and the Merchant is recommended to echo back the value.\" \n", "schema": { "type": "string", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4" } }, "sunset": { "example": "2025-07-30T06:43:40.252Z", "description": "Optional.\n\nIndicates that the resource URI will be decommissioned, and put out of service at the specified point in the future. \nMore details are available at [RFC 8594](https://www.rfc-editor.org/rfc/rfc8594.html)\n", "schema": { "type": "string", "format": "date-time", "example": "2025-07-30T06:43:40.252Z" } }, "rateLimitCount": { "description": "The maximum number of requests that the client can make in this window.", "schema": { "type": "integer", "format": "int64" }, "example": 1000 }, "rateLimitRemaining": { "description": "The number of requests allowed in the current window.", "schema": { "type": "integer", "format": "int64" }, "example": 0 }, "rateLimitReset": { "description": "The relative time in seconds when the rate limit window will be reset.", "schema": { "type": "integer", "format": "int32" }, "example": 3600 }, "retryAfter": { "description": "Indicates how long clients should wait before retrying.", "schema": { "type": "integer", "format": "int32" }, "example": 60 } }, "responses": { "unauthorized": { "description": "Not authorized. The user does not have a valid API Key or Access Token.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "WWW-Authenticate": { "schema": { "type": "string", "example": "Bearer, error=\"invalid_token\"" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "UNAUTHORIZED_REQUEST", "status": 401, "detail": null, "instance": null, "category": "UNAUTHORIZED_ERROR", "errors": [] } } } }, "forbidden": { "description": "Forbidden. The user does not have permission to access the requested resource.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "WWW-Authenticate": { "schema": { "type": "string", "example": "Bearer, error=\"insufficient_scope\"" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "FORBIDDEN_REQUEST", "status": 403, "detail": null, "instance": null, "category": "UNAUTHORIZED_ERROR", "errors": [] } } } }, "tooManyRequests": { "description": "Too Many Requests", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/rateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/rateLimitReset" } } }, "internalServer": { "description": "Unexpected error.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://api-developer.moneris.com/responsehandling/", "title": "INTERNAL_SERVER_ERROR", "status": 500, "detail": null, "instance": null, "category": "INTERNAL_SERVER_ERROR", "errors": [] } } } }, "serviceUnavailable": { "description": "Service Temporarily Unavailable", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "Retry-After": { "$ref": "#/components/headers/retryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://api-developer.moneris.com/responsehandling/", "title": "SERVICE_UNAVAILABLE", "status": 503, "detail": null, "instance": null, "category": "INTERNAL_SERVER_ERROR", "errors": [] } } } }, "badRequest": { "description": "Bad Request.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "unprocessableContent": { "description": "The API cannot complete the requested action due to semantic or business validation errors. \n", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "paymentMethodNotFoundResponse": { "description": "Payment method not found.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "NOT_FOUND", "status": 404, "detail": null, "instance": "/payment-methods/pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "category": "INVALID_REQUEST_ERROR", "errors": [] } } } }, "paymentMethodUpdateSuccessResponse": { "description": "Payment Method Updated Successfully.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" }, "example": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "CARD", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } } } } }, "concurrencyConflict": { "description": "Request could not be completed due to a concurrent access issue.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "examples": { "concurrency_error": { "$ref": "#/components/examples/concurrentRequestErrorResponse" } } } } } }, "examples": { "concurrentRequestErrorResponse": { "summary": "Concurrent Access Error", "value": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "CONCURRENCY_ERROR", "status": 409, "detail": null, "instance": null, "category": "API_ERROR", "errors": [] } }, "updatePaymentMethodInformationRequest": { "summary": "Update Payment Method request", "value": { "cardholderInformation": { "cardholderName": "John Doe", "cardholderNameDetails": { "firstName": "John", "middleName": "A", "lastName": "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" }, "credentialOnFileInformation": { "paymentIndicator": "FIRST", "paymentInformation": "NOT_USED", "issuerId": 12345678901 }, "card": { "cardNumber": "4444111122223333", "expiryMonth": 12, "expiryYear": 2033, "cardSecurityCode": 123 } } } } } } ```