{ "openapi": "3.0.3", "info": { "version": "2.6.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": "UnifiedAPI@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": "Disputes", "description": "Perform and Manage Disputes" }, { "name": "3D Secure", "description": "Perform 3D Secure authentications against payment methods" }, { "name": "Payments", "description": "Perform and Manage payments" }, { "name": "Subscriptions", "description": "Perform and Manage Subscriptions" }, { "name": "Customers", "description": "Perform and Manage customers" }, { "name": "Kount", "description": "Perform and Manage Kount risk assessment inquiries" }, { "name": "Merchant Onboarding", "description": "Manage Merchants onboarding" }, { "name": "Terminal & Service Orders", "description": "Manage Moneris Terminal & Service Orders" }, { "name": "Payment Methods", "description": "Create and Manage payment methods" }, { "name": "Refunds", "description": "Perform and Manage payment refunds" }, { "name": "Validations", "description": "Perform and Manage card validations" }, { "name": "Multi-Currency Pricing Rate Lookup", "description": "Retrieve Multi-Currency Pricing Rate Lookups" }, { "name": "Products", "description": "Product recommendations" }, { "name": "Installments", "description": "Perform and Manage Installments" } ], "paths": { "/customers": { "description": "This API allows to manage past and recurring customers.\nVery useful when tracking and managing charges belonging to the same customer.\n", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Customer", "description": "This operation is used to created a new customer.", "operationId": "createCustomers", "security": [ { "OAuth2": [ "customer.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Customers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCustomerRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/createCustomerSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List Customers", "description": "Returns a paginated list of customers.", "operationId": "getCustomers", "security": [ { "OAuth2": [ "customer.read" ] }, { "OAuth2": [ "customer.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Customers" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listCustomersSuccessResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/customers/{customer-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/customerId" }, { "$ref": "#/components/parameters/merchantId" } ], "delete": { "summary": "Delete Customer", "description": "Delete a customer by their Id", "operationId": "deleteCustomer", "security": [ { "OAuth2": [ "customer.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Customers" ], "responses": { "204": { "$ref": "#/components/responses/customerDeleteSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/customerNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "Retrieve Customer", "description": "Retrieve a customer by their Id.", "operationId": "getCustomer", "security": [ { "OAuth2": [ "customer.read" ] }, { "OAuth2": [ "customer.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Customers" ], "responses": { "200": { "$ref": "#/components/responses/retrieveCustomerSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/customerNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "put": { "summary": "Update Customer", "description": "Updates customer's details such as name, address etc...", "operationId": "updateCustomer", "security": [ { "OAuth2": [ "customer.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Customers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/customerUpdateSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/customerNotFoundResponse" }, "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" } } } }, "/disputes/{case-id}/{case-record-number}": { "get": { "tags": [ "Disputes" ], "summary": "Dispute Details", "description": "To determine whether you can upload documents for a specific case.", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/caseId" }, { "$ref": "#/components/parameters/caseRecNo" } ], "operationId": "getDisputeByCaseIdAndRecordNumber", "security": [ { "OAuth2": [ "dispute.read" ] }, { "OAuth2": [ "dispute.write" ] }, { "ApiKeyAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/getDisputeSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/disputes/{case-id}/{case-record-number}/accept": { "post": { "tags": [ "Disputes" ], "summary": "Accept Dispute", "description": "If no longer want to dispute a chargeback or copy request.", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/caseId" }, { "$ref": "#/components/parameters/caseRecNo" } ], "operationId": "acceptDispute", "security": [ { "OAuth2": [ "dispute.write" ] }, { "ApiKeyAuth": [] } ], "responses": { "204": { "$ref": "#/components/responses/disputeAcceptSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/disputes/{case-id}/{case-record-number}/uploads": { "post": { "tags": [ "Disputes" ], "summary": "Upload Images", "description": "To upload response documents associated with a disputed transaction.", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/caseId" }, { "$ref": "#/components/parameters/caseRecNo" } ], "operationId": "uploadDisputeImage", "security": [ { "OAuth2": [ "dispute.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/uploadImagesRequest" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/uploadDisputeImagesSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/disputes/{case-id}/{case-record-number}/uploads/{upload-reference-id}": { "get": { "tags": [ "Disputes" ], "summary": "Check image upload status", "description": "This endpoint can be used to check image upload status", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/caseId" }, { "$ref": "#/components/parameters/caseRecNo" }, { "$ref": "#/components/parameters/uploadReferenceId" } ], "operationId": "getDisputeUploadStatus", "security": [ { "OAuth2": [ "dispute.read" ] }, { "OAuth2": [ "dispute.write" ] }, { "ApiKeyAuth": [] } ], "responses": { "200": { "$ref": "#/components/responses/getUploadStatusSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/installments/plans": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Installment Plan Lookup", "description": "Returns list of installment plans the cardholder is eligible for.", "operationId": "installmentLookup", "tags": [ "Installments" ], "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "description": "Installment Plan Lookup request\"", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/installmentEligibilityRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/installmentLookupResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/kount-inquiries": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" } ], "post": { "summary": "Create Kount Inquiry", "operationId": "createKountInquiry", "security": [ { "OAuth2": [ "kount.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Kount" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kountInquiryRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/createKountInquirySuccessResponse" }, "202": { "$ref": "#/components/responses/createKountInquiryAcceptedResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List Kount Inquiries", "operationId": "getKountInquiries", "security": [ { "OAuth2": [ "kount.read" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Kount" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listKountInquiriesSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/kount-inquiries/{kount-inquiry-id}": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/kountInquiryId" } ], "get": { "summary": "Get Kount Inquiry by Id", "operationId": "getKountInquiryById", "security": [ { "OAuth2": [ "kount.read" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Kount" ], "responses": { "200": { "$ref": "#/components/responses/retrieveKountInquiryResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/kount-inquiries/{kount-inquiry-id}/assert": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/kountInquiryId" } ], "post": { "summary": "Kount Inquiry Assert", "operationId": "kountInquiryAssert", "security": [ { "OAuth2": [ "kount.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Kount" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kountAssertRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/assertKountInquirySuccessResponse" }, "202": { "$ref": "#/components/responses/assertKountInquiryAcceptedResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/multi-currency-pricing-rates": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Multi-Currency Pricing Rate Lookup", "description": "Performs a foreign currency exchange rate look-up, and secures that exchange rate for use in a subsequent Multi-Currency Pricing financial transaction. \nThe exchange rate retrieved by this transaction request is represented in the response as the multiCurrencyPricingRateLookupId, and the underlying exchange rate is locked in for a limited time period.\n", "operationId": "mcpRate", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Multi-Currency Pricing Rate Lookup" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/multiCurrencyPricingRateLookupRequest" } } } }, "responses": { "207": { "$ref": "#/components/responses/multiCurrencyPricingRateLookup" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/multi-currency-pricing-rates/{multi-currency-pricing-rate-lookup-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/multiCurrencyPricingRateLookupId" }, { "$ref": "#/components/parameters/merchantId" } ], "get": { "summary": "Retrieve Multi-Currency Pricing Rate by Id.", "description": "Retrieve Multi-Currency Pricing Rate results by Id.", "operationId": "getMultiCurrencyPricingRateById", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Multi-Currency Pricing Rate Lookup" ], "responses": { "200": { "$ref": "#/components/responses/multiCurrencyPricingRateLookup" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/merchants": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" } ], "post": { "summary": "Create Merchant", "description": "Submit a merchant payload to create a merchant", "operationId": "createMerchant", "security": [ { "OAuth2": [ "onboarding.merchant.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Merchant Onboarding" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createMerchantRequest" } } } }, "responses": { "201": { "description": "Successful response", "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" }, "Location": { "$ref": "#/components/headers/location" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/merchant" }, "example": { "merchantId": "0030211900875", "businessDetails": { "isSeasonalMerchant": false, "merchantCategoryCode": "0742", "averageTicketSize": 3, "directSellingPercentage": 86, "motoTransactionPercentage": 14, "ecommerceTransactionPercentage": 0, "businessUrl": "https://www.test.io", "serviceProvider": "moneris.com", "serviceDeliverToCanadaAvailable": true, "serviceDeliverToUSAvailable": true, "creditTransactionVolume": 250000, "masterCardTransactionVolume": 100000, "visaTransactionVolume": 100000, "visaDebitTransactionVolume": 0, "amexTransactionVolume": 25000, "interacTransactionVolume": 50000, "masterCardDebitTransactionVolume": 0, "category": "CONTRACTED_SERVICES", "subCategory": "VETERINARY_SERVICES", "offeredProductsAndServicesDescription": "food" }, "merchantDetails": { "contactInformation": { "firstName": "Joe", "lastName": "Test", "phone": "+11234567890" }, "merchantInformation": { "cardholderName": "Joe Test", "language": "en", "legalName": "Joe", "operatingAsName": "Joe OPS", "yearsOfOwnership": 3, "monthsOfOwnership": 2, "customerServicePhoneNumber": "+11234567890", "email": "qa-test@moneris.com", "merchantType": "NATIONAL" }, "locationAddress": { "postalCode": "M5T2G2", "city": "TORONTO", "province": "ON", "streetName": "SPADINA AVE", "country": "CA" } }, "businessActivity": { "dropShipping": true }, "securityDetails": { "legalEntity": { "businessType": "PRIVATE_CORPORATION" }, "signingOfficers": [ { "signingOfficerIdentifier": 1234, "dateOfBirth": "1980-01-01", "creditReportAllowed": true, "firstName": "DOMEMIC", "lastName": "TESTPOTKIDIS", "address": { "postalCode": "K1M1N8", "city": "OTTAWA", "province": "ON", "streetName": "STANLEY", "country": "CA" }, "ownershipPercentage": 100, "title": "VICE_PRESIDENT" } ] }, "riskDetails": { "merchantRiskRate": "A_PLUS" }, "pointOfSaleOptions": { "settlementOption": "MERCHANT_CLOSE", "settlementTime": "23:00:00", "debitPerTransactionRefundLimit": { "amount": 0, "currency": "CAD" }, "dailyRefundLimit": { "amount": 0, "currency": "CAD" }, "dailyCancellationLimit": { "amount": 0, "currency": "CAD" } }, "bankingDetails": { "creditDepositAccount": { "currency": "CAD", "institutionNumber": "00809", "transitNumber": "00160", "accountNumber": "3333333333" }, "additionalBankingAccounts": [] }, "chainId": "0030600062664", "createdAt": "2025-01-01T00:00:00Z", "modifiedAt": "2025-01-01T00:00:00Z" } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/merchants/{merchant-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/prm-merchants_merchantId" } ], "get": { "summary": "Get the details of a Merchant", "operationId": "getMerchantDetailsByMerchantId", "tags": [ "Merchant Onboarding" ], "description": "Get merchant details by ID\n", "security": [ { "OAuth2": [ "onboarding.merchant.read" ] }, { "OAuth2": [ "onboarding.merchant.write" ] }, { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Successful response corresponding to the provided merchant id parameter", "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/merchant" }, "example": { "merchantId": "0030211900875", "businessDetails": { "isSeasonalMerchant": false, "merchantCategoryCode": "0742", "averageTicketSize": 3, "directSellingPercentage": 86, "motoTransactionPercentage": 14, "ecommerceTransactionPercentage": 0, "businessUrl": "https://www.test.io", "serviceProvider": "moneris.com", "serviceDeliverToCanadaAvailable": true, "serviceDeliverToUSAvailable": true, "creditTransactionVolume": 250000, "masterCardTransactionVolume": 100000, "visaTransactionVolume": 100000, "visaDebitTransactionVolume": 0, "amexTransactionVolume": 25000, "interacTransactionVolume": 50000, "masterCardDebitTransactionVolume": 0, "category": "CONTRACTED_SERVICES", "subCategory": "VETERINARY_SERVICES", "offeredProductsAndServicesDescription": "food" }, "merchantDetails": { "contactInformation": { "firstName": "Joe", "lastName": "Test", "phone": "+11234567890" }, "merchantInformation": { "cardholderName": "Joe Test", "language": "en", "legalName": "Joe", "operatingAsName": "Joe OPS", "yearsOfOwnership": 3, "monthsOfOwnership": 2, "customerServicePhoneNumber": "+11234567890", "email": "qa-test@moneris.com", "merchantType": "NATIONAL" }, "locationAddress": { "postalCode": "M5T2G2", "city": "TORONTO", "province": "ON", "streetName": "SPADINA AVE", "country": "CA" } }, "businessActivity": { "dropShipping": true }, "securityDetails": { "legalEntity": { "businessType": "PRIVATE_CORPORATION" }, "signingOfficers": [ { "signingOfficerIdentifier": 1234, "dateOfBirth": "1980-01-01", "creditReportAllowed": true, "firstName": "DOMEMIC", "lastName": "TESTPOTKIDIS", "address": { "postalCode": "K1M1N8", "city": "OTTAWA", "province": "ON", "streetName": "STANLEY", "country": "CA" }, "ownershipPercentage": 100, "title": "VICE_PRESIDENT" } ] }, "riskDetails": { "merchantRiskRate": "A_PLUS" }, "pointOfSaleOptions": { "settlementOption": "MERCHANT_CLOSE", "settlementTime": "23:00:00", "debitPerTransactionRefundLimit": { "amount": 0, "currency": "CAD" }, "dailyRefundLimit": { "amount": 0, "currency": "CAD" }, "dailyCancellationLimit": { "amount": 0, "currency": "CAD" } }, "bankingDetails": { "creditDepositAccount": { "currency": "CAD", "institutionNumber": "00809", "transitNumber": "00160", "accountNumber": "3333333333" }, "additionalBankingAccounts": [] }, "chainId": "0030600062664", "createdAt": "2025-01-01T00:00:00Z", "modifiedAt": "2025-01-01T00:00:00Z" } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "put": { "summary": "Update Merchant", "operationId": "updateMerchant", "security": [ { "OAuth2": [ "onboarding.merchant.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Merchant Onboarding" ], "description": "Update merchant based on the supplied payload.\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/merchantPayload" } } } }, "responses": { "204": { "description": "Successful response", "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" } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/merchants/{merchant-id}/orders": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/prm-merchants_merchantId" } ], "post": { "summary": "Create Order", "description": "Submit an order payload to create an order for the merchant", "operationId": "createOrder", "security": [ { "OAuth2": [ "onboarding.order.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createOrderRequest" }, "examples": { "OrderPayload": { "$ref": "#/components/examples/CreateStandardOrderPayload" }, "OrderPayloadPartnerBank": { "$ref": "#/components/examples/CreatePartnerBankOrderPayload" } } } } }, "tags": [ "Terminal & Service Orders" ], "responses": { "201": { "description": "Successful response corresponding to the provided payload", "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/order" }, "example": { "merchantOrderId": 1471632, "merchantId": "0030211900586", "userIdentifier": "001", "representativeCode": "0A", "adjudicationRequired": true, "orderStatus": "APPLICATION_SUBMITTED", "orderType": "NET_NEW_MERCHANT", "orderOpenedAt": "2025-06-17T21:39:01.85+00:00", "orderChangedAt": "2025-06-17T22:40:55.577+00:00", "feeDetails": { "minimumMerchantDiscountRateFee": { "unitPrice": { "amount": 699, "currency": "CAD" }, "taxes": [] }, "paperStatementFee": { "unitPrice": { "amount": 795, "currency": "CAD" }, "taxes": [] }, "pciSecurityFee": { "unitPrice": { "amount": 895, "currency": "CAD" }, "taxes": [] }, "totalAdminFee": { "unitPrice": { "amount": 200, "currency": "CAD" }, "taxes": [] }, "agedCloseBatchFee": { "unitPrice": { "amount": 250, "currency": "CAD" }, "taxes": [] }, "mastercardComplianceFee": { "unitPrice": { "amount": 8000, "currency": "CAD" }, "taxes": [] }, "dialCommunicationFee": { "unitPrice": { "amount": 8, "currency": "CAD" }, "taxes": [] } }, "promotionInformation": { "promotionCode": "1MONTHOFF", "promotionName": "1MONTHOFF", "promotionExpirationDate": "2024-06-27T05:00:00+00:00" }, "supplies": [ { "supplyName": "2-PLY Sales Draft Slips (25)", "unitPrice": { "amount": 2, "currency": "CAD" }, "quantity": 1 }, { "supplyName": "Physical Distancing Arrow Decal", "unitPrice": { "amount": 6, "currency": "CAD" }, "quantity": 3 } ], "productDetails": { "wireless": { "feeDetails": { "goSoftwareFee": { "feeType": "GoSoftwareFee", "unitPrice": { "amount": 5, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGateway": { "feeDetails": { "monthlyFee": { "feeType": "MonthlyFee", "unitPrice": { "amount": 0, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationTransactionFee": { "feeType": "Visa3DSecureAuthTxn", "unitPrice": { "amount": 25, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationTransactionFee": { "feeType": "Mastercard3DSecureAuthTxn", "unitPrice": { "amount": 11, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Visa3DSecureAuthMdr", "unitPrice": { "amount": 13, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Mastercard3DSecureAuthMdr", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGoPointOfSaleRetail": { "feeDetails": { "goRetailFee": { "feeType": "GoRetailFee", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } } }, "bankerInformation": { "bankerPhoneNumber": "+19024333434", "bankerBranchIdentifier": "2679" }, "cardPlanDetails": { "selectedPlans": [ "VISA", "MASTERCARD" ], "mastercard": { "transactionPlans": [ { "merchantDiscountRate": 0.111, "transactionRate": 0.131 }, { "merchantDiscountRate": 0.111, "transactionRate": 0.131 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "mastercardDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "visa": { "transactionPlans": [ { "merchantDiscountRate": 0, "transactionRate": 0 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "visaDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "discover": { "cardBrandPlans": [], "assessmentPlans": [] }, "unionPay": { "cardBrandPlans": [], "assessmentPlans": [] }, "amex": { "cardBrandPlans": [], "assessmentPlans": [] }, "otherFinancialInstitutionCards": [], "programs": [] }, "pointOfSaleSolutionType": "MONERIS_POINT_OF_SALE", "isAcceptedByConduct": false, "contractSignatureRequired": false, "faxRequired": true, "additionalInformation": "", "businessEntityName": "Intuit", "referralInformation": { "description": "Other", "additionalInformation": "NOT USED" }, "hostType": "ESSENTIS", "autoApprovalStatus": "MANUAL_ADJUDICATION", "adjudicationApprovalStatus": "MANUAL", "hasImprinter": true, "isMarketSubSegmentationPreApprovalRequired": false, "optOutAmexCommunication": true, "multiCurrencyPricingPackageId": 1234 } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/merchants/{merchant-id}/orders/{merchant-order-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/prm-merchants_merchantId" }, { "$ref": "#/components/parameters/merchantOrderId" } ], "get": { "summary": "Retrieve order by Id", "operationId": "getOrderDetailsByOrderId", "security": [ { "OAuth2": [ "onboarding.order.read" ] }, { "OAuth2": [ "onboarding.order.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Terminal & Service Orders" ], "description": "Get order details by ID\n", "responses": { "200": { "description": "Successful response corresponding to the provided order id parameter", "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/order" }, "example": { "merchantOrderId": 1471632, "merchantId": "0030211900586", "userIdentifier": "001", "representativeCode": "0A", "adjudicationRequired": true, "orderStatus": "APPLICATION_SUBMITTED", "orderType": "NET_NEW_MERCHANT", "orderOpenedAt": "2025-06-17T21:39:01.85+00:00", "orderChangedAt": "2025-06-17T22:40:55.577+00:00", "feeDetails": { "minimumMerchantDiscountRateFee": { "unitPrice": { "amount": 699, "currency": "CAD" }, "taxes": [] }, "paperStatementFee": { "unitPrice": { "amount": 795, "currency": "CAD" }, "taxes": [] }, "pciSecurityFee": { "unitPrice": { "amount": 895, "currency": "CAD" }, "taxes": [] }, "totalAdminFee": { "unitPrice": { "amount": 200, "currency": "CAD" }, "taxes": [] }, "agedCloseBatchFee": { "unitPrice": { "amount": 250, "currency": "CAD" }, "taxes": [] }, "mastercardComplianceFee": { "unitPrice": { "amount": 8000, "currency": "CAD" }, "taxes": [] }, "dialCommunicationFee": { "unitPrice": { "amount": 8, "currency": "CAD" }, "taxes": [] } }, "promotionInformation": { "promotionCode": "1MONTHOFF", "promotionName": "1MONTHOFF", "promotionExpirationDate": "2024-06-27T05:00:00+00:00" }, "supplies": [ { "supplyName": "2-PLY Sales Draft Slips (25)", "unitPrice": { "amount": 2, "currency": "CAD" }, "quantity": 1 }, { "supplyName": "Physical Distancing Arrow Decal", "unitPrice": { "amount": 6, "currency": "CAD" }, "quantity": 3 } ], "productDetails": { "wireless": { "feeDetails": { "goSoftwareFee": { "feeType": "GoSoftwareFee", "unitPrice": { "amount": 5, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGateway": { "feeDetails": { "monthlyFee": { "feeType": "MonthlyFee", "unitPrice": { "amount": 0, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationTransactionFee": { "feeType": "Visa3DSecureAuthTxn", "unitPrice": { "amount": 25, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationTransactionFee": { "feeType": "Mastercard3DSecureAuthTxn", "unitPrice": { "amount": 11, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Visa3DSecureAuthMdr", "unitPrice": { "amount": 13, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Mastercard3DSecureAuthMdr", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGoPointOfSaleRetail": { "feeDetails": { "goRetailFee": { "feeType": "GoRetailFee", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } } }, "bankerInformation": { "bankerPhoneNumber": "+19024333434", "bankerBranchIdentifier": "2679" }, "cardPlanDetails": { "selectedPlans": [ "VISA", "MASTERCARD" ], "mastercard": { "transactionPlans": [ { "merchantDiscountRate": 0.111, "transactionRate": 0.131 }, { "merchantDiscountRate": 0.111, "transactionRate": 0.131 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "mastercardDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "visa": { "transactionPlans": [ { "merchantDiscountRate": 0, "transactionRate": 0 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "visaDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "discover": { "cardBrandPlans": [], "assessmentPlans": [] }, "unionPay": { "cardBrandPlans": [], "assessmentPlans": [] }, "amex": { "cardBrandPlans": [], "assessmentPlans": [] }, "otherFinancialInstitutionCards": [], "programs": [] }, "pointOfSaleSolutionType": "MONERIS_POINT_OF_SALE", "isAcceptedByConduct": false, "contractSignatureRequired": false, "faxRequired": true, "additionalInformation": "", "businessEntityName": "Intuit", "referralInformation": { "description": "Other", "additionalInformation": "NOT USED" }, "hostType": "ESSENTIS", "autoApprovalStatus": "MANUAL_ADJUDICATION", "adjudicationApprovalStatus": "MANUAL", "hasImprinter": true, "isMarketSubSegmentationPreApprovalRequired": false, "optOutAmexCommunication": true, "multiCurrencyPricingPackageId": 1234 } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "put": { "summary": "Update an order by ID", "operationId": "updateOrder", "security": [ { "OAuth2": [ "onboarding.order.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateOrderRequest" }, "examples": { "OrderPayload": { "$ref": "#/components/examples/UpdateStandardOrderPayload" }, "OrderPayloadPartnerBank": { "$ref": "#/components/examples/UpdatePartnerBankOrderPayload" } } } } }, "tags": [ "Terminal & Service Orders" ], "responses": { "200": { "description": "Successful response corresponding to the provided payload", "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/order" }, "example": { "merchantOrderId": 1471632, "merchantId": "0030211900586", "userIdentifier": "001", "representativeCode": "0A", "adjudicationRequired": true, "orderStatus": "APPLICATION_SUBMITTED", "orderType": "NET_NEW_MERCHANT", "orderOpenedAt": "2025-06-17T21:39:01.85+00:00", "orderChangedAt": "2025-06-17T22:40:55.577+00:00", "feeDetails": { "minimumMerchantDiscountRateFee": { "unitPrice": { "amount": 699, "currency": "CAD" }, "taxes": [] }, "paperStatementFee": { "unitPrice": { "amount": 795, "currency": "CAD" }, "taxes": [] }, "pciSecurityFee": { "unitPrice": { "amount": 895, "currency": "CAD" }, "taxes": [] }, "totalAdminFee": { "unitPrice": { "amount": 200, "currency": "CAD" }, "taxes": [] }, "agedCloseBatchFee": { "unitPrice": { "amount": 250, "currency": "CAD" }, "taxes": [] }, "mastercardComplianceFee": { "unitPrice": { "amount": 8000, "currency": "CAD" }, "taxes": [] }, "dialCommunicationFee": { "unitPrice": { "amount": 8, "currency": "CAD" }, "taxes": [] } }, "promotionInformation": { "promotionCode": "1MONTHOFF", "promotionName": "1MONTHOFF", "promotionExpirationDate": "2024-06-27T05:00:00+00:00" }, "supplies": [ { "supplyName": "2-PLY Sales Draft Slips (25)", "unitPrice": { "amount": 2, "currency": "CAD" }, "quantity": 1 }, { "supplyName": "Physical Distancing Arrow Decal", "unitPrice": { "amount": 6, "currency": "CAD" }, "quantity": 3 } ], "productDetails": { "wireless": { "feeDetails": { "goSoftwareFee": { "feeType": "GoSoftwareFee", "unitPrice": { "amount": 5, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGateway": { "feeDetails": { "monthlyFee": { "feeType": "MonthlyFee", "unitPrice": { "amount": 0, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationTransactionFee": { "feeType": "Visa3DSecureAuthTxn", "unitPrice": { "amount": 25, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationTransactionFee": { "feeType": "Mastercard3DSecureAuthTxn", "unitPrice": { "amount": 11, "currency": "CAD" }, "waivePeriod": null }, "visa3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Visa3DSecureAuthMdr", "unitPrice": { "amount": 13, "currency": "CAD" }, "waivePeriod": null }, "mastercard3dSecureAuthenticationMerchantDiscountRateFee": { "feeType": "Mastercard3DSecureAuthMdr", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } }, "monerisGoPointOfSaleRetail": { "feeDetails": { "goRetailFee": { "feeType": "GoRetailFee", "unitPrice": { "amount": 10, "currency": "CAD" }, "waivePeriod": null } } } }, "bankerInformation": { "bankerPhoneNumber": "+19024333434", "bankerBranchIdentifier": "2679" }, "cardPlanDetails": { "selectedPlans": [ "VISA", "MASTERCARD" ], "mastercard": { "transactionPlans": [ { "merchantDiscountRate": 0.111, "transactionRate": 0.131 }, { "merchantDiscountRate": 0.111, "transactionRate": 0.131 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "mastercardDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "visa": { "transactionPlans": [ { "merchantDiscountRate": 0, "transactionRate": 0 } ], "cardBrandPlans": [], "assessmentPlans": [], "serviceFeeDetails": { "maintenanceFee": { "feeType": "maintenance", "unitPrice": { "amount": 301, "currency": "CAD" } } } }, "visaDebit": { "cardBrandPlans": [], "assessmentPlans": [] }, "discover": { "cardBrandPlans": [], "assessmentPlans": [] }, "unionPay": { "cardBrandPlans": [], "assessmentPlans": [] }, "amex": { "cardBrandPlans": [], "assessmentPlans": [] }, "otherFinancialInstitutionCards": [], "programs": [] }, "pointOfSaleSolutionType": "MONERIS_POINT_OF_SALE", "isAcceptedByConduct": false, "contractSignatureRequired": false, "faxRequired": true, "additionalInformation": "", "businessEntityName": "Intuit", "referralInformation": { "description": "Other", "additionalInformation": "NOT USED" }, "hostType": "ESSENTIS", "autoApprovalStatus": "MANUAL_ADJUDICATION", "adjudicationApprovalStatus": "MANUAL", "hasImprinter": true, "isMarketSubSegmentationPreApprovalRequired": false, "optOutAmexCommunication": true, "multiCurrencyPricingPackageId": 1234 } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/merchants/{merchant-id}/supplies": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/prm-merchants_merchantId" } ], "get": { "summary": "List merchant supplies", "operationId": "listMerchantSupplies", "security": [ { "OAuth2": [ "onboarding.merchant.read" ] }, { "OAuth2": [ "onboarding.merchant.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Merchant Onboarding" ], "description": "Get merchant supplies by merchant ID\n", "responses": { "200": { "description": "Successful response corresponding to the provided payload", "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/merchantSupplies" }, "example": { "data": [ { "deviceName": "iWL220 + Communication Base", "carriers": [ "Telus", "Rogers" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0010", "unitPrice": { "amount": 10, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] }, { "deviceName": "iWL220 + Charge Base", "carriers": [ "Telus", "Rogers" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0011", "unitPrice": { "amount": 11, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] }, { "deviceName": "iWL220 Communication Base", "carriers": [ "Telus", "Rogers" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0014", "unitPrice": { "amount": 14, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] }, { "deviceName": "iWL220 Charge Base", "carriers": [ "Telus", "Rogers" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0019", "unitPrice": { "amount": 19, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] }, { "deviceName": "iWL255 + Charge Base", "carriers": [ "Rogers", "Telus" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0460", "unitPrice": { "amount": 9900, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Case/Shoulder Strap for iWL255", "unitPrice": { "amount": 4700, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Car Charger for iWL255", "unitPrice": { "amount": 3350, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] }, { "deviceName": "iWL255", "carriers": [ "Rogers", "Telus" ], "softwareVendors": [ "DataCandy" ], "serviceCode": "0461", "unitPrice": { "amount": 461, "currency": "CAD" }, "supplyType": "wireless", "supplies": [ { "supplyName": "Torx 25 Security Wrench and Screws", "unitPrice": { "amount": 950, "currency": "CAD" } }, { "supplyName": "Case/Shoulder Strap for iWL255", "unitPrice": { "amount": 4700, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter and Plate", "unitPrice": { "amount": 1600, "currency": "CAD" } }, { "supplyName": "Manual Flatbed Imprinter Replacement Plate", "unitPrice": { "amount": 2000, "currency": "CAD" } }, { "supplyName": "Paper Rolls - 2.25\"x1.64\"x62 (15)", "unitPrice": { "amount": 1650, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Thermal 2.25\"x1.64\" (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } }, { "supplyName": "Car Charger for iWL255", "unitPrice": { "amount": 3350, "currency": "CAD" } }, { "supplyName": "Paper Rolls - Phenol-free: 62' (100)", "unitPrice": { "amount": 7080, "currency": "CAD" } } ] } ] } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/onboarding/product-recommendations": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/acceptLanguage" } ], "post": { "summary": "List Recommended Products", "operationId": "getRecommenderProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/productRecommendationRequest" } } } }, "tags": [ "Products" ], "description": "Get recommender products to fetch multiple items related to a client\n", "security": [ { "OAuth2": [ "onboarding.order.read" ] }, { "OAuth2": [ "onboarding.order.write" ] }, { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Successful response corresponding to the provided payload", "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/productRecommendation" }, "example": { "allowToSell": true, "solutions": [ { "solutionIdentifier": 1, "solutionName": "Moneris® Go", "solutionDescription": "A Moneris Go terminal is ideal for merchants who want flexible functionality inside a sleek white touchscreen device.", "solutionImageUrl": "https://ordernow.moneris.com/landing/moneris_go/PAX_3QU.webp", "solutionPrices": [ { "pricingLabel": "Credit Card Processing Fee", "pricingText": "2.65% + $0.10" }, { "pricingLabel": "Keyed-in transactions", "pricingText": "2.85% + $0.30" }, { "pricingLabel": "Interac Debit processing fee", "pricingText": "$0.10" }, { "pricingLabel": "Monthly fee per terminal", "pricingText": "$9.99/month" } ], "solutionFeatures": [ { "description": "Wireless connectivity" }, { "description": "Credit & debit payments" }, { "description": "Smart terminal" }, { "description": "Stylish and sleek design" } ], "additionalSolutionDetailsUrl": "https://ordernow.moneris.com/landing/moneris-go", "maximumQuantity": 1, "carrierOptions": [ "Rogers", "Telus" ] } ] } } } }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payment-methods": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Payment Method", "description": "Create a Payment Method.", "operationId": "createPaymentMethod", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPaymentMethodRequest" }, "examples": { "card": { "$ref": "#/components/examples/cardPaymentMethodRequest" }, "temporary_token": { "$ref": "#/components/examples/temporaryTokenPaymentMethodRequest" }, "permanent_token": { "$ref": "#/components/examples/permanentTokenPaymentMethodRequest" }, "apple_pay_encrypted": { "$ref": "#/components/examples/applePayEncryptedPaymentMethodRequest" }, "apple_pay_decrypted": { "$ref": "#/components/examples/applePayDecryptedPaymentMethodRequest" }, "google_pay_encrypted": { "$ref": "#/components/examples/googlePayEncryptedPaymentMethodRequest" }, "google_pay_decrypted": { "$ref": "#/components/examples/googlePayDecryptedPaymentMethodRequest" } } } } }, "responses": { "201": { "$ref": "#/components/responses/createPaymentMethodSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List payment methods", "description": "Retrieves a paginated list of payment methods.", "operationId": "getPaymentMethods", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listPaymentMethodsResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payment-methods/{payment-method-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentMethodId" }, { "$ref": "#/components/parameters/merchantId" } ], "delete": { "summary": "Delete Payment Method", "description": "Deletes a payment method.", "operationId": "deletePaymentMethod", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "responses": { "204": { "$ref": "#/components/responses/paymentMethodDeleteSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/paymentMethodNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "Retrieve Payment Method", "description": "Retrieve a Payment Method by Id", "operationId": "getPaymentMethod", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "responses": { "200": { "$ref": "#/components/responses/retrievePaymentMethodSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/paymentMethodNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "put": { "summary": "Update Payment method", "description": "Update payment method referenced by its Id. \nCertain details may not be updated if the payment method was used in a transaction.\n", "operationId": "updatePaymentMethod", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payment Methods" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updatePaymentMethodRequest" }, "examples": { "card": { "$ref": "#/components/examples/updateCardPaymentMethodRequest" }, "temporary_token": { "$ref": "#/components/examples/updateTemporaryTokenPaymentMethodRequest" }, "permanent_token": { "$ref": "#/components/examples/updatePermanentTokenPaymentMethodRequest" }, "apple_pay_encrypted": { "$ref": "#/components/examples/applePayEncryptedPaymentMethodRequest" }, "apple_pay_decrypted": { "$ref": "#/components/examples/applePayDecryptedPaymentMethodRequest" }, "google_pay_encrypted": { "$ref": "#/components/examples/googlePayEncryptedPaymentMethodRequest" }, "google_pay_decrypted": { "$ref": "#/components/examples/googlePayDecryptedPaymentMethodRequest" } } } } }, "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" } } } }, "/payments": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Payment", "description": "This operation is used to initiate a Payment.", "operationId": "createPayments", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPaymentRequest" }, "examples": { "regularPurchaseWithPaymentMethodId": { "$ref": "#/components/examples/regularPurchaseWithPaymentMethodId" }, "regularPurchaseWithCardPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithCardPaymentMethod" }, "regularPurchaseWithTemporaryPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithTemporaryPaymentMethod" }, "regularPurchaseWithPermanentPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithPermanentPaymentMethod" }, "regularPurchaseWithApplePayEncryptedPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithApplePayEncryptedPaymentMethod" }, "regularPurchaseWithApplePayDecryptedPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithApplePayDecryptedPaymentMethod" }, "regularPurchaseWithGooglePayEncryptedPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithGooglePayEncryptedPaymentMethod" }, "regularPurchaseWithGooglePayDecryptedPaymentMethod": { "$ref": "#/components/examples/regularPurchaseWithGooglePayDecryptedPaymentMethod" }, "preAuthorizationWithPaymentMethodId": { "$ref": "#/components/examples/preAuthorizationWithPaymentMethodId" }, "preAuthorizationWithCardPaymentMethod": { "$ref": "#/components/examples/preAuthorizationWithCardPaymentMethod" }, "preAuthorizationWithTemporaryToken": { "$ref": "#/components/examples/preAuthorizationWithTemporaryToken" }, "preAuthorizationWithPermanentToken": { "$ref": "#/components/examples/preAuthorizationWithPermanentToken" } } } } }, "responses": { "201": { "$ref": "#/components/responses/createPaymentSuccessResponse" }, "400": { "$ref": "#/components/responses/createPaymentBadRequestResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/createPaymentUnprocessableContentResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List Payments", "description": "Returns a paginated list of payments.", "operationId": "getPayments", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listPaymentsResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payments/{payment-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/merchantId" } ], "get": { "summary": "Retrieve Payment", "description": "Retrieve a payment by its payment Id", "operationId": "getPayment", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "responses": { "200": { "$ref": "#/components/responses/retrievePaymentSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payments/{payment-id}/cancel": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Cancel Payment", "description": "Cancel a payment. This operation may not be possible if the payment has gone through.", "operationId": "cancelPayment", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelPaymentRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/cancelPaymentSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/cancelPaymentUnprocessableContentResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payments/{payment-id}/complete": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Complete Payment", "description": "This will effectively capture a payment that has been authorized.", "operationId": "completePayment", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/completionRequest" }, "example": { "idempotencyKey": "5d8f812e-9969-4885-85bb-d03948eccac2", "invoiceNumber": "1a2s3d45v6", "customData": { "property1": "string", "property2": "string" }, "amount": { "amount": 16000, "currency": "CAD" } } } } }, "responses": { "200": { "$ref": "#/components/responses/completePaymentSuccessResponse" }, "400": { "$ref": "#/components/responses/completePaymentBadRequestResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/completePaymentUnprocessableContentResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/payments/{payment-id}/increment": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Increment Payment", "description": "Increases the locked amount of funds in an existing pre-authorization (Payment with automaticCapture = false) for later settle by a single pre-authorization completion. There is no limit to the number of Increment Payment API calls on the original estimated authorization and each new Increment Payment increases the hold on the customer's credit card.\n", "operationId": "incrementPayment", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Payments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incrementalAuthorizationRequest" }, "example": { "idempotencyKey": "5d8f812e-9969-4885-85bb-d03948eccac2", "invoiceNumber": "1a2s3d45v6", "customData": { "property1": "string", "property2": "string" }, "amount": { "amount": 10000, "currency": "CAD" }, "dynamicDescriptor": "moneris" } } } }, "responses": { "200": { "$ref": "#/components/responses/incrementalAuthorizationSuccessResponse" }, "400": { "$ref": "#/components/responses/completePaymentBadRequestResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/completePaymentUnprocessableContentResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/refunds": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Refund", "description": "This operation is used to create a Refund. \nFor payment refunds, Payment Id is required while payment method is not required.\nFor independent refunds, no payment Id is required, however payment method is required.\n", "operationId": "createRefund", "security": [ { "OAuth2": [ "refund.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Refunds" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createRefundRequest" }, "examples": { "matching": { "$ref": "#/components/examples/matchingRefundRequest" } } } } }, "responses": { "201": { "$ref": "#/components/responses/createRefundSuccessResponse" }, "400": { "$ref": "#/components/responses/createRefundBadRequestResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/createRefundDeclinedResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List Refunds", "description": "Returns a paginated list of refund operations.", "operationId": "getRefunds", "security": [ { "OAuth2": [ "refund.read" ] }, { "OAuth2": [ "refund.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Refunds" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listRefundsSuccessResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/refunds/{refund-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/refundId" }, { "$ref": "#/components/parameters/merchantId" } ], "get": { "summary": "Retrieve Refund", "description": "Retrieve a refund by its Id.", "operationId": "getRefundById", "security": [ { "OAuth2": [ "refund.read" ] }, { "OAuth2": [ "refund.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Refunds" ], "responses": { "200": { "$ref": "#/components/responses/retrieveRefundSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/refundNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Subscription", "description": "

This operation is used to create a Subscription.

\n

\n Webhooks\n

\n
\n Webhook Definition Details\n
\n
\n
application/json
\n
\n \n

Webhook Request Body

\n

\n

This is the base definition for all event messages. It contains the common properties that are shared across all events.

\n

\n
\n
\n
\n
\n \n Name\n
\n
\n \n Required\n
\n
\n Additional\n Info\n
\n
\n \n Description\n
\n
\n
\n
\n
\n
\n eventId
\n
\n true
\n
\n \n string\n
\n
\n

Identifier of the triggered\n event. Can be used\n as an idempotency key to\n detect duplicates.

\n
\n
\n
\n
\n eventType
\n
\n true
\n
\n \n string\n
\n
\n

This is a\n list of all the types of\n events we currently\n send.

\n
    \n
  • RECURRING_PAYMENT_CONFIRMED: A payment transaction has been executed.
    • \n
\n
\n
\n
\n
\n occuredAt
\n
\n true
\n
\n \n date-time\n
\n
\n

the timestamp of when the event occurred (not\n necessarily the same of when it was\n delivered)

\n
\n
\n
\n
\n apiVersion
\n
\n false
\n
\n \n string\n
\n
\n

The Moneris API Version used to\n populate the event\n payload.

\n
\n
\n
\n
\n objectId
\n
\n false
\n
\n \n string\n
\n
\n

Used to\n identify API resources which\n may be required for\n future follow-on\n transactions; i.e. Refunds,\n Corrections,\n Completions, Reversals,\n etc.

\n
\n
\n
\n
\n href
\n
\n false
\n
\n \n string\n
\n
\n

Uniform\n resource locator to retrieve\n resource\n details.

\n
\n
\n
\n
\n correlationId
\n
\n false
\n
\n \n string\n
\n
\n

Correlation Id transmitted during the\n original request.\n This is useful to correlate between\n multiple events corresponding to same\n flow.

\n
\n
\n
\n
\n data
\n
\n false
\n
\n \n payment\n
\n
\n

The Payment data associated with the\n event.

\n
\n
\n
\n
\n \n

\n
\n
\n
\n json\n \n
\n
\n 
\n{\n  \"title\": \"webhookRequest\",\n  \"required\": [\n    \"eventId\",\n    \"eventType\",\n    \"occuredAt\",\n  ],\n  \"type\": \"object\",\n  \"properties\": {\n  \"eventId\": {\n    \"type\": \"string\"\n    \"description\": \"Unique Identifier for the Event.\",\n    \"pattern\": \"^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$\",\n    \"minLength\": 30,\n    \"maxLength\": 30,\n    \"example\": \"ev0105ARZ3NDEKTSV4RRFFQ69G5FAV\"\n  },\n  \"eventType\": {\n    \"type\": \"string\",\n    \"description\": \"This is a list of all the types of events we currently send. RECURRING_PAYMENT_CONFIRMED\",\n    \"enum\": [\n        \"RECURRING_PAYMENT_CONFIRMED\"\n    ]\n    \"example\": RECURRING_PAYMENT_CONFIRMED\n  },\n  \"occuredAt\": {\n    \"type\": \"string\",\n    \"description\": \"Date & Time at which the event has occurred.\",\n    \"format\": \"date-time\",\n    \"example\": 2025-02-17T18:00:00Z\n  },\n  \"apiVersion\": {\n    \"type\": \"string\",\n    \"description\": \"The Moneris API Version used to populate the event payload.\",\n    \"nullable\": true,\n    \"example\": 2024-09-17\n  },\n  \"objectId\": {\n    \"type\": \"string\",\n    \"description\": \"Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.\",\n    \"nullable\": true,\n    \"example\": pi0105ARZ3NDEKTSV4RRFFQ69G5FAV\n  },\n  \"href\": {\n    \"type\": \"string\",\n    \"description\": \"Uniform resource locator to retrieve resource details\",\n    \"format\": \"uri-reference\",\n    \"nullable\": true,\n    \"example\": /payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV\n  },\n  \"correlationId\": {\n    \"type\": \"string\",\n    \"description\": \"Correlation Id transmitted during the original request.\",\n    \"nullable\": true,\n    \"example\": \"f0d4c76f-f129-4b91-92a3-9a120829bbe5\",\n  },\n  \"data\": {\n    \"type\": \"object\",\n    \"description\": \"Full representation of the resource that triggered the event. For Payments, it will be the Payment object\",\n    \"nullable\": true\n  }\n}\n
\n \n \n
\n
\n

Response 200 OK

\n

\n

Webhook event processed successfully

\n

\n

Response 400 Bad Request

\n

\n

An error has occured while processing webhook event

\n

\n
\n
", "operationId": "createSubscriptions", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSubscriptionRequest" }, "examples": { "subscriptionRequestWithImmediateInitialAmount": { "$ref": "#/components/examples/subscriptionRequestWithImmediateInitialAmount" }, "dailyPaymentRequestToStartAtbillingStartDate": { "$ref": "#/components/examples/dailyPaymentRequestToStartAtbillingStartDate" }, "weeklyPaymentRequestToStartAtbillingStartDate": { "$ref": "#/components/examples/weeklyPaymentRequestToStartAtbillingStartDate" }, "biweeklyPaymentRequestToStartAtbillingStartDate": { "$ref": "#/components/examples/biweeklyPaymentRequestToStartAtbillingStartDate" }, "monthlyPaymentRequestToStartAtbillingStartDate": { "$ref": "#/components/examples/monthlyPaymentRequestToStartAtbillingStartDate" }, "endOfMonthPaymentRequestToStartAtbillingStartDate": { "$ref": "#/components/examples/endOfMonthPaymentRequestToStartAtbillingStartDate" } } } } }, "responses": { "201": { "$ref": "#/components/responses/createSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List subscriptions", "description": "Returns a paginated list of subscriptions.", "operationId": "getSubscriptions", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listSubscriptionsResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions/{subscription-id}": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/subscriptionId" } ], "get": { "summary": "Retrieve Subscription", "description": "Retrieve a Subscription details by Id", "operationId": "getSubscription", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "responses": { "200": { "$ref": "#/components/responses/retrieveSubscriptionSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "patch": { "summary": "Update Subscription", "description": "Update Subscription\n", "operationId": "updateSubscription", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/updateSubscriptionDetails" } } } }, "responses": { "200": { "$ref": "#/components/responses/updateSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions/{subscription-id}/cancel": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/subscriptionId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Cancel Subscription", "description": "Cancel a Subscription.", "operationId": "cancelSubscription", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelSubscriptionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/cancelSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions/{subscription-id}/extend": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/subscriptionId" } ], "post": { "summary": "Extend Subscription", "description": "Adds the given number of subscription transactions to the current (remaining) number.\n\nThis can be used if a customer decides to extend a membership/subscription. \nHowever, because this must be a positive number, it cannot be used to decrease the current number of subscription transactions. \nFor that, use Update Subscription.\n", "operationId": "extendSubscription", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/extendSubscriptionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/extendSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions/{subscription-id}/pause": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/subscriptionId" } ], "post": { "summary": "Pause Subscription", "description": "Temporarily pauses subscription billing.\nWhile a transaction is on hold, it is not billed for the subscription amount. \nHowever, the number of remaining recurs continues to be decremented during that time.\n", "operationId": "pauseSubscription", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pauseSubscriptionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/pauseSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/subscriptions/{subscription-id}/resume": { "parameters": [ { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/subscriptionId" } ], "post": { "summary": "Resume Subscription", "description": "Resumes a subscription billing.\nWhile a transaction is on hold, it is not billed for the subscription amount. \nHowever, the number of remaining recurs continues to be decremented during that time.\n", "operationId": "resumeSubscription", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Subscriptions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resumeSubscriptionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/resumeSubscriptionSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/surcharge-lookups": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Surcharge Lookup", "description": "Performs surcharge lookup and determines if payment method is eligible or not and provides max rate and max amount if eligible.", "operationId": "surchargeLookUp", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Surcharge Lookup" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurchargeEligibilityRequest" }, "example": { "idempotencyKey": "5d8f812e-9969-4885-85bb-d03948eccac1", "amount": { "amount": 16000, "currency": "CAD" }, "paymentMethod": { "paymentMethodSource": "CARD", "card": { "cardNumber": "4444111122223333", "expiryMonth": 1, "expiryYear": 2025, "cardSecurityCode": "123" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/SurchargeEligibilitySuccessfulResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/three-d-secure/authentications": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Authentication", "description": "This operation is used to create an Authentication request. \nThe authentication request is used to start the validation process of the card. \nThe result of this request determines whether 3DS is supported by the card and what type of authentication is required.\n", "operationId": "createAuthentication", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "3D Secure" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authenticationRequest" }, "examples": { "threeDSecureBrowserChannelWithPaymentMethodId": { "$ref": "#/components/examples/threeDSecureBrowserChannelWithPaymentMethodId" }, "threeDSecureBrowserChannelWithCardPaymentMethod": { "$ref": "#/components/examples/threeDSecureBrowserChannelWithCardPaymentMethod" }, "threeDSecureBrowserChannelWithTemporaryToken": { "$ref": "#/components/examples/threeDSecureBrowserChannelWithTemporaryToken" }, "threeDSecureBrowserChannelWithPermanentToken": { "$ref": "#/components/examples/threeDSecureBrowserChannelWithPermanentToken" } } } } }, "responses": { "201": { "$ref": "#/components/responses/createThreeDSecureAuthenticationSuccessResponse" }, "202": { "$ref": "#/components/responses/createThreeDSecureAuthenticationChallengeResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/three-d-secure/authentications/{authentication-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" }, { "$ref": "#/components/parameters/authenticationId" } ], "get": { "summary": "Retrieve Authentication", "description": "Retrieve an authentication by its authentication Id", "operationId": "getAuthentication", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "3D Secure" ], "responses": { "200": { "$ref": "#/components/responses/retrieveThreeDSecureAuthenticationSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/three-d-secure/authentications/{authentication-id}/lookup": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/authenticationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Authentication Value Lookup", "description": "The point of the 3-D Secure flow is to verify that the true cardholder is a part of the authorization. The challenge flow is used to present a way of authenticating the cardholder using e.g. OTP or a federated identification method.", "operationId": "authenticationValueLookup", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "3D Secure" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lookupRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/threeDSecureAuthenticationLookupSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/three-d-secure/card-lookups": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "3DS Card Lookup", "operationId": "cardLookup", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "3D Secure" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cardLookupRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/createThreeDSecureCardLookupSuccessResponse" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/validations": { "description": "set up a payment method for future payments. \nSimilar to a payment, but no charge is created.\nUseful when onboarding customers but not charging them right away.\n", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "post": { "summary": "Create Card Validation", "description": "Initiate a new Card Validation request.", "operationId": "createValidation", "security": [ { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Validations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createValidationRequest" }, "examples": { "with_payment_method_id": { "$ref": "#/components/examples/validationWithPaymentMethodId" }, "with_card_payment_method": { "$ref": "#/components/examples/validationWithCardPaymentMethod" }, "with_temporary_token_payment_method": { "$ref": "#/components/examples/validationWithTemporaryTokenPaymentMethod" }, "with_permanent_token_payment_method": { "$ref": "#/components/examples/validationWithPermanentTokenPaymentMethod" }, "with_apple_pay_encrypted_payment_method": { "$ref": "#/components/examples/validationWithApplePayEncryptedPaymentMethod" }, "with_apple_pay_decrypted_payment_method": { "$ref": "#/components/examples/validationWithApplePayDecryptedPaymentMethod" }, "with_google_pay_encrypted_payment_method": { "$ref": "#/components/examples/validationWithGooglePayEncryptedPaymentMethod" }, "with_google_pay_decrypted_payment_method": { "$ref": "#/components/examples/validationWithGooglePayDecryptedPaymentMethod" } } } } }, "responses": { "201": { "description": "Validation request created 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/validation" } } } }, "400": { "description": "Failed Validation operation result response", "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": { "invalid_request": { "$ref": "#/components/examples/InvalidRequestErrorResponse" } } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "description": "Failed Validation operation result response", "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": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" } } } } }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } }, "get": { "summary": "List Card Validations", "description": "Returns a paginated list of the card validations the were executed.", "operationId": "getValidations", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Validations" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listValidationsSuccessResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } }, "/validations/{validation-id}": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/validationId" }, { "$ref": "#/components/parameters/merchantId" } ], "get": { "summary": "Retrieve Card Validation.", "description": "Retrieve a Card Validation by Id.", "operationId": "getValidation", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Validations" ], "responses": { "200": { "$ref": "#/components/responses/retrieveValidationSuccessResponse" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/validationNotFoundResponse" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } } }, "components": { "schemas": { "SurchargeEligibility": { "type": "object", "properties": { "merchantId": { "$ref": "#/components/schemas/merchantId" }, "amount": { "description": "Represents the surcharge amount", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "surchargeMessage": { "type": "string", "description": "Message indicating surcharge eligibility status" }, "maximumSurchargeRate": { "type": "number", "format": "double", "description": "Maximum surcharge rate applicable" }, "maximumSurchargeAmount": { "$ref": "#/components/schemas/money" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" } }, "required": [ "merchantId", "amount", "surchargeMessage", "maximumSurchargeRate", "maximumSurchargeAmount", "paymentMethod" ] }, "SurchargeEligibilityRequest": { "title": "surchargeEligibilityRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "amount": { "description": "This is for surcharge amount.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "paymentMethod": { "$ref": "#/components/schemas/surChargePaymentMethodRequest" } }, "required": [ "idempotencyKey", "paymentMethod", "amount" ] }, "accountNumber": { "type": "string", "description": "Attribute that represent the unique identifier for a bank account.", "nullable": true, "maxLength": 10 }, "addionalBankingAccountType": { "type": "string", "description": "The type of the additional banking account.", "enum": [ "POS_BILLING_ACCOUNT", "CHARGEBACK_ACCOUNT", "DEBIT_DEPOSIT_ACCOUNT" ] }, "additionalBankingAccount": { "type": "object", "description": "An object that contains additional banking account information.", "allOf": [ { "$ref": "#/components/schemas/bank" }, { "type": "object", "required": [ "accountType" ], "properties": { "accountType": { "$ref": "#/components/schemas/addionalBankingAccountType" } } } ] }, "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" } }, "addressVerificationServiceResultCode": { "title": "AVS Result Description", "type": "string", "nullable": true, "description": "Indicates the address verification result. \n", "enum": [ "FULL_MATCH", "PARTIAL_MATCH", "NO_MATCH", "UNAVAILABLE", null ], "example": "FULL_MATCH" }, "addressee": { "description": "a (natural or legal) person that gets addressed", "type": "object", "properties": { "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "companyName": { "$ref": "#/components/schemas/companyName" } }, "required": [ "firstName", "lastName" ] }, "agreementModelCode": { "type": "string", "description": "A code that identifies the specific type or model of agreement associated with the order or account.", "nullable": true, "maxLength": 15 }, "agreementModelInformation": { "type": "object", "description": "An object containing the agreement model info details.", "nullable": true, "properties": { "agreementModelCode": { "$ref": "#/components/schemas/agreementModelCode" } } }, "amexTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through American Express payments.", "format": "int32", "example": 1000 }, "amount": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 999999999, "example": 10000, "description": "Amount" }, "amountDetails": { "description": "Contains information pertaining to the subtotal, tip, and surcharge amounts of a Payment", "type": "object", "nullable": true, "properties": { "subTotalAmount": { "$ref": "#/components/schemas/subTotalAmount" }, "tipAmount": { "$ref": "#/components/schemas/tipAmount" }, "surchargeAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "annualVolume": { "type": "integer", "description": "The annual volume of transactions processed by the business.", "format": "int32" }, "apiVersion": { "description": "The endpoint's API Version. Must be provided through headers.\n", "type": "string", "example": "2025-08-14", "default": "2025-08-14" }, "applePayDecryptedWallet": { "title": "applePayDecryptedWallet", "description": "Apple Pay wallet details after decrypting the token.", "allOf": [ { "$ref": "#/components/schemas/paymentMethodRequestBase" }, { "type": "object", "properties": { "applicationPrimaryAccountNumber": { "description": "The unique identifier for the primary account number for the payment card.", "type": "string", "pattern": "^[0-9]{13,19}$", "example": "4242424242424242" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "deviceManufacturerIdentifier": { "$ref": "#/components/schemas/deviceManufacturerIdentifier" }, "dataType": { "$ref": "#/components/schemas/dataType" }, "cryptogram": { "$ref": "#/components/schemas/walletCryptogram" }, "cardBrand": { "type": "string", "description": "Card Brand.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "INTERAC", "DISCOVER" ] }, "walletEcommerceIndicator": { "$ref": "#/components/schemas/walletEcommerceIndicator" }, "walletIndicator": { "$ref": "#/components/schemas/walletIndicator" } }, "required": [ "applicationPrimaryAccountNumber", "expiryMonth", "expiryYear", "dataType", "cryptogram", "cardBrand", "walletIndicator" ] } ], "required": [ "paymentMethodSource" ] }, "applePayEncryptedWallet": { "title": "applePayEncryptedWallet", "description": "Apple Pay encrypted wallet details.", "allOf": [ { "$ref": "#/components/schemas/paymentMethodRequestBase" }, { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display Name", "example": "MasterCard 4079" }, "cardBrand": { "type": "string", "description": "Card Brand.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "INTERAC", "DISCOVER" ], "example": "MASTERCARD" }, "applePayVersion": { "type": "string", "description": "Version information about the payment token.\n - EC_V1: For ECC-encrypted data\n - RSA_V1: For RSA-encrypted data\n", "enum": [ "EC_V1", "RSA_V1" ], "example": "EC_V1" }, "data": { "type": "string", "description": "Encrypted payment data. Base64 encoded as a string.\n", "format": "byte", "example": "MTIzNDU2Njc4OQ==" }, "signature": { "type": "string", "description": "Signature of the payment and header data, Base64 encoded as a string. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm. Can be a detached PKCS #7 signature, Base64 encoded as a string\n" }, "publicKeyHash": { "type": "string", "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate. Can be either a base64 encoded or SHA-256 Hash string.\n" }, "ephemeralPublicKey": { "type": "string", "description": "Ephemeral public key bytes. Only for RSA_v1. Can be either a base64 encoded string or X.509 bytes.\n", "format": "byte" }, "applePayTransactionId": { "type": "string", "description": "The Apple Pay unique identifier for a transaction such as an in-app purchase, restored in-app purchase, or subscription renewal." }, "walletIndicator": { "$ref": "#/components/schemas/walletIndicator" } }, "required": [ "displayName", "cardBrand", "applePayVersion", "data", "signature", "publicKeyHash", "ephemeralPublicKey", "applePayTransactionId", "walletIndicator" ] } ], "required": [ "paymentMethodSource" ] }, "applicablePromotions": { "type": "array", "description": "A list of promotion codes applicable to the order.", "maxItems": 10, "items": { "type": "string", "maxLength": 100 } }, "applicationDetails": { "type": "object", "description": "Details about the application", "nullable": true, "properties": { "applicationType": { "type": "string", "description": "The type of application being submitted", "enum": [ "NET_NEW_MERCHANT", "EXISTING_MERCHANT_ADD_POS", "EXISTING_MERCHANT_UPGRADE_POS" ], "example": "NET_NEW_MERCHANT", "nullable": true } } }, "assessmentPlan": { "type": "object", "description": "An object containing all details related to assessment plan.", "properties": { "merchantDiscountRate": { "description": "The merchant discount rate applied to transactions under the assessment plan.", "type": "number", "format": "double", "default": 0, "minimum": 0, "maximum": 1 }, "transactionRate": { "description": "The single payment processing event under the assessment plan.", "type": "number", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "feeTypeCode": { "$ref": "#/components/schemas/feeTypeCode" }, "cardOriginCode": { "$ref": "#/components/schemas/cardOriginCode" } } }, "assessmentPlans": { "type": "array", "description": "A list of assessment items.", "items": { "$ref": "#/components/schemas/assessmentPlan" }, "maxItems": 20 }, "authenticationRequest": { "title": "authenticationRequest", "description": "Use the 3DS Authentication request to start the validation process of the card and cardholder identity. This request supports all 3DS authentication methods, including 3DS Requestor Initiated (3RI) and Decoupled Authentication. The fields device_channel and message_category control the type of 3DS request made. To perform a standard 3DS Authentication with a cardholder browser experience, send device_channel = 02 for BRW. The result of this request determines whether the card supports 3DS features and, if supported, whether the transaction uses a frictionless or challenge flow. To perform a 3DS Requestor Initiated Authentication without a cardholder browser experience, send device_channel = 03 for 3RI. Any fields related to the browser’s challenge prompt are no longer required, but other conditional fields for 3RI become mandatory.", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "cardLookupId": { "nullable": true, "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" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "amount": { "$ref": "#/components/schemas/money" }, "cardholderName": { "$ref": "#/components/schemas/cardholderName" }, "cardholderEmail": { "$ref": "#/components/schemas/email" }, "cardholderPhoneNumber": { "$ref": "#/components/schemas/phoneNumber" }, "shippingAddress": { "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" } }, "billingAddress": { "$ref": "#/components/schemas/threeDSecureAuthenticationBillingAddress" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodRequest" }, "threeDSecureMessageCategory": { "$ref": "#/components/schemas/threeDSecureMessageCategory" }, "threeDSecureDeviceChannel": { "$ref": "#/components/schemas/threeDSecureDeviceChannel" }, "threeDSecureRequestType": { "$ref": "#/components/schemas/threeDSecureRequestType" }, "threeDSecureRecurringFrequency": { "$ref": "#/components/schemas/threeDSecureRecurringFrequency" }, "threeDSecureRecurringExpiry": { "$ref": "#/components/schemas/threeDSecureRecurringExpiry" }, "threeDSecureRequestorInitiatedIndicator": { "$ref": "#/components/schemas/threeDSecureRequestorInitiatedIndicator" }, "threeDSecurePriorAuthenticationInformation": { "$ref": "#/components/schemas/threeDSecurePriorAuthenticationInformation" }, "threeDSecureNotificationUrl": { "nullable": true, "type": "string", "description": "URL-encoded, fully qualified callback URL that receives the response or error message. \n\nNote: Request with URL that is not URL-encoded will be rejected for security reasons.\n\nExample (URL-encoded): https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123\n", "minLength": 1, "maxLength": 256, "example": "https%3A%2F%2Fdeveloper.moneris.com%2F" }, "threeDSecureCompletionIndicator": { "$ref": "#/components/schemas/threeDSecureCompletionIndicator" }, "threeDSecureChallengeRequested": { "$ref": "#/components/schemas/threeDSecureChallengeRequested" }, "threeDSecureChallengeWindowSize": { "$ref": "#/components/schemas/threeDSecureChallengeWindowSize" }, "browserIpAddress": { "description": "IP address the browser is connecting from.", "type": "string", "format": "ipv4", "example": "104.75.173.179", "nullable": true }, "browserUserAgent": { "$ref": "#/components/schemas/browserUserAgent" }, "browserJavaEnabled": { "$ref": "#/components/schemas/browserJavaEnabled" }, "browserJavascriptEnabled": { "$ref": "#/components/schemas/browserJavascriptEnabled" }, "browserScreenHeight": { "$ref": "#/components/schemas/browserScreenHeight" }, "browserScreenWidth": { "$ref": "#/components/schemas/browserScreenWidth" }, "browserLanguage": { "nullable": true, "type": "string", "format": "iso-639", "description": "Provides the two letter language code according the ISO 639-1 standard. \n\nFor a complete list of language codes, visit: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.\n", "minLength": 2, "maxLength": 2, "example": "en" } }, "required": [ "amount", "billingAddress", "browserIpAddress", "browserScreenHeight", "browserScreenWidth", "cardholderEmail", "cardholderName", "cardholderPhoneNumber", "idempotencyKey", "threeDSecureDeviceChannel", "threeDSecureMessageCategory" ] }, "authorizationCode": { "type": "string", "maxLength": 8, "nullable": true, "pattern": "^[a-zA-Z0-9]*$", "description": "Contains a value generated by the authorizer for an approved financial transactions. \nThis operates as the authorizing host's transaction identification.\n", "example": "11223344" }, "authorizationDescription": { "type": "string", "description": "A description of the authorization process or requirements for the transaction.", "nullable": true, "maxLength": 10 }, "automaticCapture": { "type": "boolean", "description": "- **true**: (Default) will prompt Moneris to capture the payment when it is authorized. This performs a Purchase transaction.\n- **false**: will prompt Moneris to place a hold on the funds when the payment is authorized. This performs a Pre-Authorization transaction.\n", "default": true }, "automaticNumberId": { "description": "Automatic Number Identification (ANI) submitted with order If the ANI cannot be determined, merchant must pass 0123456789 as the ANID NOTE: This field is only valid for phone-to-web requests where customer service agents navigate to a separate order entry page that does not collect iframe data Risk Inquiry Service submissions", "type": "string", "maxLength": 32, "example": "0123456789", "nullable": true }, "averageTicketSize": { "type": "integer", "description": "A numeric value representing the average transaction amount for the business.", "format": "int32" }, "bank": { "type": "object", "description": "An object that contains information about the bank associated with the account or transaction.", "required": [ "currency", "institutionNumber", "transitNumber", "accountNumber" ], "properties": { "currency": { "$ref": "#/components/schemas/currency" }, "institutionNumber": { "$ref": "#/components/schemas/institutionNumber" }, "transitNumber": { "$ref": "#/components/schemas/transitNumber" }, "accountNumber": { "$ref": "#/components/schemas/accountNumber" } } }, "bankerInformation": { "type": "object", "description": "An object containing all details related to banker information.", "properties": { "bankerEmail": { "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" }, "bankerEmployeeNumber": { "nullable": true, "type": "string", "description": "A string attribute that uniquely identifies the employee of the bank responsible.", "maxLength": 20, "example": "242200024" }, "bankerName": { "nullable": true, "type": "string", "description": "The full name of the banker representative.", "maxLength": 50, "example": "MONIKA CARNOKA" }, "bankerPhoneNumber": { "nullable": true, "type": "string", "description": "Phone number.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "bankerPhoneNumberExtension": { "nullable": true, "type": "string", "description": "The phone number extension of the banker representative.", "maxLength": 50, "pattern": "^[0-9]{1,6}$", "example": "1068" }, "bankerTransitNumber": { "nullable": true, "type": "string", "description": "The identifier of the transit bank associated.", "maxLength": 5, "example": "00160", "pattern": "^\\d{5}" }, "bankerBranchIdentifier": { "nullable": true, "type": "string", "description": "The branch identifier of the bank where the banker is located.", "maxLength": 5, "example": "2679" } } }, "bankingDetails": { "type": "object", "description": "An object that contains the necessary banking information related to the account or transaction.", "required": [ "creditDepositAccount" ], "properties": { "creditDepositAccount": { "$ref": "#/components/schemas/bank" }, "additionalBankingAccounts": { "type": "array", "description": "A list of additional banking accounts associated with the merchant.", "items": { "$ref": "#/components/schemas/additionalBankingAccount" }, "maxItems": 10 } } }, "billingDetails": { "type": "object", "description": "Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.", "properties": { "billingIntervalUnit": { "$ref": "#/components/schemas/billingIntervalUnit" }, "billingIntervalFrequency": { "$ref": "#/components/schemas/billingIntervalFrequency" }, "billingIntervalCount": { "$ref": "#/components/schemas/subscriptionIntervalCount" }, "billingAmount": { "description": "The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "billingStartDate": { "description": "Date of the first future subscription billing transaction. This value must be a date in the future.", "type": "string", "format": "date", "example": "2019-07-30" } }, "required": [ "billingIntervalUnit", "billingIntervalFrequency", "billingIntervalCount", "billingStartDate", "billingAmount" ] }, "billingInformation": { "type": "object", "description": "Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.", "properties": { "billingIntervalUnit": { "$ref": "#/components/schemas/billingIntervalUnit" }, "billingIntervalFrequency": { "$ref": "#/components/schemas/billingIntervalFrequency" }, "billingIntervalCount": { "$ref": "#/components/schemas/subscriptionIntervalCount" }, "billingAmount": { "description": "The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "billingStartDate": { "description": "Date of the first future subscription billing transaction. This value must be a date in the future.", "type": "string", "format": "date", "example": "2019-07-30" }, "nextBillingDate": { "description": "Date on which the next payment will occur", "nullable": true, "type": "string", "format": "date", "example": "2019-07-30" }, "billingEndDate": { "description": "Date on which the subscription will end.", "nullable": true, "type": "string", "format": "date", "example": "2019-07-30" } }, "required": [ "billingIntervalUnit", "billingIntervalFrequency", "billingIntervalCount", "billingStartDate", "billingAmount" ], "example": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-02-28" } }, "billingIntervalFrequency": { "type": "integer", "format": "int32", "description": "Number of interval units passing between subscribed payments. Frequencies higher than 1 cause the subscription to skip intervals, such as bi-weekly (2 weeks) or annual subscriptions (12 months).\n", "minimum": 1, "maximum": 999, "example": 1 }, "billingIntervalUnit": { "type": "string", "description": "Controls whether the recurring series occurs on a: daily (`DAY`), weekly (`WEEK`), or monthly (`MONTH`) basis. \n\nTo ensure regular schedules, use `END_OF_MONTH` for schedules occurring on the last day of each month.\n", "enum": [ "DAY", "WEEK", "MONTH", "END_OF_MONTH" ] }, "bookmark": { "type": "object", "description": "An object containing details about the Bookmark product.", "nullable": true, "properties": { "packageFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "packageName": { "type": "string", "description": "The package associated with the Bookmark product.", "maxLength": 50, "nullable": true }, "licenseName": { "type": "string", "description": "The name of the license associated with the Bookmark product.", "maxLength": 50, "nullable": true }, "referringSalesRepresentativeCode": { "type": "string", "description": "The code of the sales representative referring the Bookmark product.", "maxLength": 50, "nullable": true }, "bundleName": { "type": "string", "description": "The name of the bundle associated with the Bookmark product.", "maxLength": 50, "nullable": true }, "hasShoppingCard": { "type": "boolean", "description": "A boolean flag indicating whether the Bookmark product has a shopping card option." }, "shoppingCardOptionName": { "type": "string", "description": "The name of the shopping card option associated with the Bookmark product.", "maxLength": 50, "nullable": true } } }, "bookmarkPro": { "type": "object", "description": "An object containing details about the Bookmark Pro product.", "nullable": true, "properties": { "professionalFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "referringSalesRepresentativeCode": { "type": "string", "nullable": true, "description": "The code of the sales representative referring the Bookmark Pro product.", "maxLength": 50 } } }, "browserJavaEnabled": { "type": "boolean", "description": "Indicates whether Java is enabled in the browser", "example": true }, "browserJavascriptEnabled": { "type": "boolean", "description": "Indicates whether Javascript is enabled in the browser", "example": true }, "browserScreenHeight": { "type": "integer", "format": "int32", "description": "Defines the pixel height of the cardholder's screen.", "minimum": 0, "maximum": 999999, "example": 1080 }, "browserScreenWidth": { "type": "integer", "format": "int32", "description": "Defines the pixel width of the cardholder's screen.", "minimum": 0, "maximum": 999999, "example": 1920 }, "browserUserAgent": { "type": "string", "description": "Exact content of the HTTP user-agent header.\nNote, when total length exceeds 2048 characters, truncate the excess portion.\n", "maxLength": 2048, "example": "Mozilla/5.0 (Linux; {Android Version}; {Build Tag etc.})", "nullable": true }, "businessActivity": { "type": "object", "description": "An object containing all details about the business activity.", "required": [ "dropShipping" ], "properties": { "dropShipping": { "$ref": "#/components/schemas/dropShipping" } } }, "businessCategory": { "type": "string", "description": "The category of the business.", "nullable": true, "maxLength": 255, "example": "RESTAURANTS", "enum": [ "AIRLINES", "AMUSEMENT_AND_ENTERTAINMENT", "AUTOMOBILE_VEHICLE_RENTAL", "AUTOMOBILES_AND_VEHICLES", "BUSINESS_SERVICES", "CONTRACTED_SERVICES", "GOVERNMENT_SERVICES", "HOTELS_AND_MOTELS", "MAIL_ORDER_TELEPHONE_ORDER_PROVIDERS", "PERSONAL_SERVICE_PROVIDERS", "PROFESSIONAL_SERVICES_AND_MEMBERSHIPS", "REPAIR_SERVICES", "RESTAURANTS", "RETAILER", "RETAILERS", "SERVICE_PROVIDERS", "TRANSPORTATION", "UTILITIES", "WHOLESALERS_MANUFACTURERS" ] }, "businessDetails": { "type": "object", "description": "An object containing key information about the business associated with the account or transaction.", "required": [ "merchantCategoryCode", "isSeasonalMerchant", "directSellingPercentage", "motoTransactionPercentage", "ecommerceTransactionPercentage" ], "properties": { "merchantCategoryCode": { "$ref": "#/components/schemas/merchantCategoryCode" }, "averageTicketSize": { "$ref": "#/components/schemas/averageTicketSize" }, "isSeasonalMerchant": { "$ref": "#/components/schemas/isSeasonalMerchant" }, "maximumTransactionVolume": { "$ref": "#/components/schemas/maximumTransactionVolume" }, "directSellingPercentage": { "$ref": "#/components/schemas/directSellingPercentage" }, "motoTransactionPercentage": { "$ref": "#/components/schemas/motoTransactionPercentage" }, "ecommerceTransactionPercentage": { "$ref": "#/components/schemas/ecommerceTransactionPercentage" }, "businessUrl": { "$ref": "#/components/schemas/businessUrl" }, "serviceProvider": { "$ref": "#/components/schemas/serviceProvider" }, "serviceDeliverToCanadaAvailable": { "$ref": "#/components/schemas/serviceDeliverToCanadaAvailable" }, "serviceDeliverToUSAvailable": { "$ref": "#/components/schemas/serviceDeliverToUSAvailable" }, "creditTransactionVolume": { "$ref": "#/components/schemas/creditTransactionVolume" }, "masterCardTransactionVolume": { "$ref": "#/components/schemas/masterCardTransactionVolume" }, "visaTransactionVolume": { "$ref": "#/components/schemas/visaTransactionVolume" }, "visaDebitTransactionVolume": { "$ref": "#/components/schemas/visaDebitTransactionVolume" }, "amexTransactionVolume": { "$ref": "#/components/schemas/amexTransactionVolume" }, "interacTransactionVolume": { "$ref": "#/components/schemas/interacTransactionVolume" }, "masterCardDebitTransactionVolume": { "$ref": "#/components/schemas/masterCardDebitTransactionVolume" }, "unionPayTransactionVolume": { "$ref": "#/components/schemas/unionPayTransactionVolume" }, "discoverTransactionVolume": { "$ref": "#/components/schemas/discoverTransactionVolume" }, "category": { "$ref": "#/components/schemas/businessCategory" }, "subCategory": { "$ref": "#/components/schemas/businessSubCategory" }, "offeredProductsAndServicesDescription": { "$ref": "#/components/schemas/offeredProductsAndServicesDescription" }, "riskLevel": { "$ref": "#/components/schemas/riskLevel" } } }, "businessSubCategory": { "type": "string", "description": "The sub-category of the business.", "nullable": true, "enum": [ "A_1_RENT_A_CAR", "ACCOUNTING", "ACTION_RENT_A_CAR", "ADAMS_MARK", "ADRIA", "ADVANTAGE_RENT_A_CAR", "ADVERTISING", "AER_LINGUS", "AERO_COACH_AVIATION", "AERO_PERU", "AERO_SERVICO_CARABOBO", "AERO_VIRGIN_ISLANDS", "AEROLINEAS_ARGENTINAS", "AEROLINEAS_NICARAGUENSIS", "AEROMEXICO", "AFFILIATED_AUTO_RENTAL", "AGENCY_RENT_A_CAR", "AGRICULTURAL_COOPERATIVES", "AIR_AFRIQUE", "AIR_ALGERIE", "AIR_BRITISH_COLUMBIA", "AIR_CANADA", "AIR_CHINA", "AIR_CONDITIONER", "AIR_CONDITIONING_CONTRACTOR", "AIR_COURIER", "AIR_DJIBOUTI", "AIR_FRANCE", "AIR_INDIA", "AIR_JAMAICA", "AIR_LANKA", "AIR_LITTORAL", "AIR_MAURITIUS", "AIR_NEW_ZEALAND", "AIR_PANAMA", "AIR_SEYCHELLES", "AIR_ZAIRE", "AIR_ZIMBABWE", "AIRCRAFT_EQUIPMENT", "AIRINTER", "AIRPORT_TERMINALS", "AIRPORTS", "AIRWAYS_RENT_A_CAR", "AJAX_RENT_A_CAR", "ALAMO_RENT_A_CAR", "ALASKA", "ALCOHOL_STORE", "ALIMONY", "ALL_NIPPON", "ALLSTATE_RENT_A_CAR", "ALM_ANTILEAN", "ALOHA", "ALTERATIONS", "ALTRA_RENT_A_CAR", "AMBULANCE_SERVICES", "AMELIA_ISLAND_PLANTATION", "AMERICA_WEST", "AMERICAN", "AMERICAN_INT_RENT_A_CAR", "AMERICAN_TRANS_AIR", "AMERICANA", "AMERISUITES", "AMFAC", "AMUSEMENT_PARKS", "ANA", "ANSA_INTERNATIONAL_RENT_A_CAR", "ANSETT", "ANTIQUE_REPAIR", "ANTIQUE_REPRODUCTION", "ANTIQUE_RESTORATION", "ANTIQUES", "APPLIANCE", "AQUARIUMS", "ARABELLA", "ARCADE", "ARCHITECTS", "ARCTIA", "ART_DEALERS", "ART_SUPPLIES", "ARTIFICIAL_LIMBS", "ASIANA", "ATHLETIC_FIELDS", "ATTORNEYS", "AUBERGE_DES_GOVERNMENTS", "AUDITING", "AUSTRIAN", "AUSTRIAN_AIR_SERVICE", "AUTO_BODY", "AUTO_CASH_FI", "AUTO_DEALER_USED", "AUTO_HOST_CAR_RENTAL", "AUTOHANSA_RENT_A_CAR", "AUTOMATE_RENT_A_CAR", "AUTOMATED_FUEL_DISPENSER", "AUTOMOBILE_ASSOCIATION", "AUTOMOTIVE_PAINT", "AUTOMOTIVE_SERVICE", "AUTOMOTIVE_SERVICE_SHOPS", "AVCAR_RENT_A_CAR", "AVENSA", "AVIANCA", "AVIATION_FUEL", "AVIS_RENT_A_CAR", "AVON_RENT_A_CAR", "AWNINGS", "BAHAMAS_AIR", "BAIL_PAYMENTS", "BAKERIES", "BALLYS", "BANDS", "BAR_HARBOUR", "BARBER_SHOP", "BARS", "BEAU_RIVAGE", "BEAUTY_SALON", "BEAUTY_SPA", "BEER", "BELLAGIO", "BEMIDJI", "BEST_WESTERN", "BICYCLE_SALES", "BICYCLE_SERVICE", "BIG_BOX_HOME_SUPPLIERS", "BILLIARD_AND_POOL_HALL", "BILTMORE", "BINIONS_HORSESHOE_CLUB", "BLINDS", "BLUEPRINTING", "BOAT_DEALER", "BOAT_LEASES", "BOAT_RENTALS", "BOCA_RATON_RESORT", "BOND_PAYMENTS", "BOOKKEEPING", "BOOKS", "BOTANICAL_GARDENS", "BOWLING_ALLEYS", "BOYS_CLOTHING", "BRADBURY_SUITES", "BRIDGE_TOLLS", "BRITISH_AIRWAYS", "BRITISH_MIDLAND", "BROADMOOR", "BROCKWAY", "BROKERS", "BROOKS_RENT_A_CAR", "BUDGET_HOST_INNS", "BUDGET_RENT_A_CAR", "BUDGETEL_INNS", "BUFFALO_BILLS", "BUILDING_SUPPLIES", "BUS_LINES", "BUSES_LOCAL", "BUSINESS_SCHOOLS", "BUSINESS_SERVICES_OTHER", "BUTCHERS", "BUYING_SERVICES", "BWIA_INTERNATIONAL", "CABLE_SERVICES", "CABS", "CAESARS", "CALIFORNIA", "CAMERA", "CAMP_GROUNDS", "CAMPANILE", "CAMPER_DEALER", "CANADIAN", "CANDY", "CANYON_RANCH", "CAPTITOL", "CAR_ACCESSORIES", "CAR_AUTO_BODY", "CAR_PAINTING", "CAR_PARTS", "CAR_SERVICE", "CAR_SUPPLIES", "CAR_WASHERS", "CAREFREE_RESORTS", "CAREY_RENT_A_CAR", "CARLTON", "CARNIVAL", "CARNIVALS", "CARPENTER", "CARPET", "CARPET_CLEANING", "CATALOGUE", "CATALOGUE_AND_RETAIL", "CATERERS", "CATHAY_PACIFIC", "CHARITABLE_ORG", "CHATEAU_ELAN_RESORT", "CHEMICALS_OTHER", "CHILD_CARE", "CHILD_SUPPORT", "CHILDRENS_CLOTHING", "CHINA", "CHINA_EASTERN", "CHIROPODISTS", "CHIROPRACTORS", "CIGA", "CIGAR_STAND", "CIGARS", "CIRCUS_CIRCUS", "CIRCUSES", "CITE_RENT_A_CAR", "CITY_LODGE", "CIVIC_ASSOCIATIONS", "CLARION", "CLEANING_AND_MAINTENANCE", "CLEANING_PRODUCTS", "CLIMATE_DE_FRANCE", "CLOCK", "CLUB_MED", "COAL_DEALER", "COAST", "COIN", "COLLECTION_AGENCIES", "COLLEGES", "COLORADO_BELLE", "COMAIR", "COMFORT_INNS", "COMMAND", "COMMERCIAL_CLOTHING", "COMMERCIAL_CONTRACTOR", "COMMERCIAL_EQUIPMENT_OTHER", "COMMERCIAL_FOOTWEAR", "COMMERCIAL_FURNITURE", "COMMERCIAL_LAUNDRY", "COMMERCIAL_PHOTOGRAPHER", "COMMERCIAL_SPORTS", "COMPANIA_FAUCETT", "COMPANIA_PANEMENA", "COMPRI", "COMPUTER_EQUIPMENT", "COMPUTER_INFORMATION_SERVICES", "COMPUTER_NETWORK_SERVICES", "COMPUTER_PROGRAMMING", "COMPUTER_SERVICES", "COMPUTER_SERVICES_OTHER", "COMPUTER_SOFTWARE", "CONCORDE", "CONCRETE_WORK", "CONFECTIONERY", "CONSORT", "CONSTRUCTION_MATERIALS_OTHER", "CONSULTING_SERVICES", "CONTINENTAL", "CONTRACTORS_SPECIAL_TRADE", "CORNER_STORE", "CORRESPONDENCE_SCHOOLS", "COSMETICS", "COUNTRY_CLUBS", "COUNTRY_INN_BY_CARLSON", "COURIER_SERVICES", "COURT_COSTS", "COURTYARD_INNS", "CP", "CRAFT_SHOWS", "CRAFT_SUPPLIES", "CREDIT_REPORTING_AGENCIES", "CREMATORIUMS", "CROATIA", "CROWN", "CROWNE_PLAZA", "CRUISE_LINES", "CRUZEIRO", "CRYSTAL", "CSA", "CUMBERLAND", "CUMULOS", "CUNARD", "CURTAIN", "CYPRUS_AIR", "DAIRY_PRODUCTS", "DAN", "DAN_AIR", "DANCE_HALLS", "DANCE_SCHOOL", "DANCE_STUDIO", "DATA_PROCESSING_SERVICES", "DATING_SERVICE", "DAY_CARE_CENTERS", "DAYS_INNS", "DE_VERA", "DEALERS", "DEBT_COUNSELING", "DELTA", "DENTAL_EQUIPMENT", "DENTAL_LABORATORIES", "DENTISTS", "DEPARTMENT_STORE", "DETECTIVE_AGENCY", "DIGITAL_APPLICATIONS", "DIGITAL_GAMES", "DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC", "DILLON_INNS", "DIRECT_MARKETING", "DISCO", "DISCOUNT_STORE", "DISINFECTORS", "DISNEYLAND", "DOCTORS_OTHER", "DOLLAR_RENT_A_CAR", "DOLLAR_STORE", "DOLPHYINARIUMS", "DOOR_TO_DOOR_SALES", "DORAL", "DORNIT", "DOUBLETREE", "DOWNTOWER_PASSPORT", "DRAPERY", "DRIVE_IN_THEATER", "DRUG", "DRUG_SUPPLIES", "DRURY_INN", "DRY_CLEANER", "DRY_GOODS", "DUNFEY", "DURABLE_GOODS_OTHER", "DUTY_FREE", "DVD_RENTAL", "ECONO_CAR_RENT_A_CAR", "ECONOLODGES", "ECONOMY_INNS", "ECUATORIANA", "EGYPTAIR", "EL_AL", "ELDORADO", "ELECTRIC_CHARGING_STATION", "ELECTRIC_UTILITY", "ELECTRICAL", "ELECTRICAL_CONTRACTORS", "ELECTRICAL_PARTS_EQUIPMENT", "ELECTRONIC", "ELECTRONICS", "ELEMENTARY_SCHOOLS", "EMBASSY", "EMBASSY_SUITES", "EMIRATES", "ENGINEERS", "ENTERPRISE_RENT_A_CAR", "EQUESTRIAN", "ESCORT_SERVICE", "ETHIOPIAN", "EUROPE_BY_CAR", "EUROPE_CAR", "EVA", "EXCALIBUR", "EXCEL_INN", "EXPOSITIONS", "EXTERMINATORS", "FABRIC", "FAIRFIELD", "FAIRFIELD_INN", "FAIRMONT", "FAMILY_CLOTHING", "FAMILY_LAUNDRY", "FARM_EQUIPMENT", "FAST_FOOD_RESTAURANT", "FAX_PACKAGES", "FERRIES", "FI_AUTO_CASH", "FI_MANUAL_CASH", "FILM_DEVELOPING", "FINES", "FINNAIR", "FIREPLACE", "FIREPLACE_ACCESSORIES", "FLAG_INN", "FLOOR_COVERING", "FLORIST", "FLORIST_SUPPLIES", "FLOWER_SUPPLIES", "FLOWERS", "FLYING_FIELDS", "FOOD_STORES_OTHER", "FOOTWEAR_COMMERCIAL", "FORMAL_WEAR", "FORTE", "FORTUNE_TELLERS", "FORUM", "FOUR_POINTS", "FOUR_SEASONS", "FRATERNAL_ASSOCIATIONS", "FREEDOM", "FREEZER", "FREIGHT_CARRIERS", "FREIGHT_COURIER", "FREMONT", "FRIENDSHIP_INNS", "FRONTIER", "FUEL_DEALERS", "FUNERAL_HOMES", "FUR_STORE", "FURNITURE", "FURNITURE_EQUIPMENT", "FURNITURE_LEASING", "FURNITURE_OFFICE_COMMERCIAL", "FURNITURE_REFINISHING", "FURNITURE_RENTAL", "FURRIER", "GALLERY", "GAMBLING_TRANSACTIONS", "GAME", "GARAGES", "GARDENS", "GARMENT_CLEANING", "GARUDA", "GAS_STATION_AUTOMATED", "GAS_STATIONS", "GAS_UTILITY", "GENERAL_CONTRACTOR", "GENERAL_RENT_A_CAR", "GIFT_CARD", "GLASS", "GLASSES", "GLASSWARE", "GODFREY_RENT_A_CAR", "GOLDEN_NUGGET", "GOLDEN_PACIFIC", "GOLDEN_TULIP", "GOLF_COURSES_PUBLIC", "GOVERNMENTAL_SERVICES_OTHER", "GRAPHIC_ART", "GREENBRIAN_RESORT", "GROCERY_STORE", "GROUND_COURIER", "GULF", "GUYANA", "HALEKULANI", "HAMPTON_INN", "HARDWARE_EQUIPMENT", "HARDWARE_STORE", "HARLEY", "HARRAHS", "HARVEY_BRISTOL", "HAT_CLEANING", "HAVASU", "HAWAIIAN", "HEALTH_SPA", "HEARING_AID_SUPPLIES", "HEARING_AIDS", "HEATING_CONTRACTOR", "HEATING_EQUIPMENT", "HELMSLEY", "HERTZ_RENT_A_CAR", "HILTON", "HILTON_INTERNATIONAL", "HOBBY_SHOP", "HOLIDAY_INNS", "HOLIDAY_RENT_A_CAR", "HOME_FURNISHINGS", "HOME_FURNISHINGS_OTHER", "HOME_SUPPLY_WAREHOUSE", "HORTICULTURAL_SERVICES", "HOSPITAL_EQUIPMENT", "HOSPITALITY_INNS", "HOSPITALS", "HOTEL_IBIS", "HOTEL_MELIA", "HOTEL_MERCURE", "HOTEL_OKURA", "HOTEL_UNIVERSAL", "HOTELES_EL_PRESIDENTE", "HOUSEHOLD_APPLIANCES", "HOWARD_JOHNSON_INN", "HUDSON_HOTEL", "HUNGAR", "HUSA", "HYATT", "IBERTOL", "IBUSZ", "ICELANDIAR", "IMPERIAL_LONDON", "INBOUND_TELEMARKETING", "INDIAN", "INDUSTRIAL_SUPPLIES_OTHER", "INFANTS_CLOTHING", "INFORMATION_SERVICES", "INNKEEPERS", "INSTRUMENT", "INSURANCE", "INSURANCE_PREMIUMS", "INSURANCE_RENT_A_CAR", "INSURANCE_UNDERWRITING", "INTEGRATED_SYSTEMS_DESIGN", "INTERCONTINENTAL", "INTERENT_RENT_A_CAR", "INTERHOTEL_CLERK", "INTERNOR_HOTELS", "ISLAND", "ITA_AIRWAYS", "JANITORIAL_SERVICES", "JAPAN", "JEWELLERY", "JOHN_ASCUAGAS_NUGGET", "JOLLY", "JOURNEYS_END_MOTELS", "JUGOSLAV", "KAHALA_MANDARIN_ORIENTAL", "KAROS", "KEMWELL_GROUP_RENT_A_CAR", "KENYA", "KLM", "KM_MALTA_AIRLINES", "KNIGHTS_INN", "KOREAN", "KUWAIT", "LA_MANSION_DEL_RIO", "LA_QUINTA_MOTOR_INNS", "LAB_BOLIVIA", "LABORATORIES_NON_MEDICAL", "LABORATORY_EQUIPMENT", "LACSA_COSTA_RICA", "LADBROKE", "LADECO", "LADY_LUCK", "LANCHILE", "LANDSCAPING_SERVICES", "LAP", "LAUNDROMATS", "LAUNDRY_CLEANING", "LAUNDRY_FAMILY", "LAV_LINEA_VENEZOLANA", "LAWN_AND_GARDEN", "LEASING_EQUIPMENT", "LEATHER_GOODS", "LEGAL_SERVICES", "LIAT", "LIMOUSINES", "LIQUOUR", "LOCAL_TELEPHONE_ACCESS", "LOCAL_TRANSPORTATION", "LOEWS", "LONG_DISTANCE_TELEPHONE_PACKAGES", "LOT", "LOTTERY", "LUFTHANSA", "LUGGAGE", "LUMBER", "LUXAIR", "LUXOR", "MAIN_STREET_STATION", "MAJOR_RENT_A_CAR", "MALAYSIAN", "MALEV", "MANAGEMENT_SERVICES", "MANDALAY_BAY_RESORT", "MANDARIN_ORIENTAL", "MANUAL_CASH_FI", "MARINAS", "MARINE_SERVICE", "MARINE_SUPPLIES", "MARITIM", "MARKETPLACES", "MARRIAGE_COUNSELING", "MARRIOTT", "MASONRY", "MASSAGE_PARLORS", "MASTERS_ECONOMY_INNS", "MEAT_FREEZERS", "MEAT_LOCKER_PROVISIONERS", "MEAT_MARKETS", "MEDICAL_EQUIPMENT", "MEDICAL_LABORATORIES", "MEDICAL_OTHER", "MEMBER_MERCHANDISE", "MEMBERSHIP_CLUBS", "MEMBERSHIP_OTHER", "MEN_AND_BOYS_CLOTHING", "MEN_AND_WOMENS_CLOTHING", "MENDING", "MERIDIAN", "MERLIN", "MESA", "METAL_SERVICES_CENTERS", "METAL_SERVICES_OFFICES", "METRO", "METROFLIGHT", "METROPOLE", "MEXICANA", "MGM_GRAND", "MICROFILM_EQUIPMENT", "MIDDLE_EAST", "MIDWAY_MOTOR_LODGE", "MIDWEST_EXPRESS", "MILLENNIUM_BROADWAY", "MILLEVILLE_RENT_A_CAR", "MIRGAGE", "MISC_ENTERTAINERS", "MIYAKO", "MOBILE_HOME_DEALER", "MONTE_CARLO", "MOTEL_6", "MOTION_PICTURE_PRODUCTION", "MOTION_PICTURE_THEATRES", "MOTOR_HOME_DEALER", "MOTOR_HOME_RENTAL", "MOTOR_VEHICLE_SUPPLIES", "MOTORCYCLE_DEALER", "MOTORCYCLE_SHOP", "MOUNT_CHARLOTTE_THISTLE", "MOUNT_COOK", "MOVENPICK", "MOVERS_TRUCKS", "MOVIE_PRODUCTION", "MOVIE_THEATER", "MUSEUMS", "MUSIC", "NANNIES", "NATIONAIR", "NATIONAL_CAR_RENTAL", "NEEDLEWORK", "NEVELE_GRAND", "NEW_AND_USED_TRUCK_DEALER", "NEW_OTANI", "NEW_PARTS_CARS", "NEW_YORK_NEW_YORK", "NEW_YORK_HELICOPTER", "NEWS_DEALERS", "NEWS_STANDS", "NEWSPAPERS", "NIGERIA", "NIGHTCLUB", "NOAHS", "NONDURABLE_GOODS_OTHER", "NON_FIN_INSTITUTION_STORED_CARD_PURCHASE_LOAD", "NON_MEDICAL_LABORATORIES", "NORONTAIR", "NORTHWEST", "NOVELTY_GOODS", "NOVOTEL", "NUMISMATIC_SUPPLIES", "NURSERY", "NURSERY_SCHOOLS", "NURSERY_STOCK", "NURSING_HOME", "NUTS", "OBEROI", "OFFICE_EQUIPMENT", "OFFICE_FURNITURE", "OFFICE_SUPPLIES", "OIL_DEALER", "OLYMPIC", "OMNI", "OPHTHALMIC_EQUIPMENT", "OPHTHALMOLOGISTS", "OPRYLAND", "OPTICAL_GOODS", "OPTICIANS", "OPTOMETRISTS", "ORCHESTRAS", "ORTHODONTISTS", "ORTHOPEDIC_GOODS", "OSTEOPATHS", "OTHER_AIRLINE", "OTHER_BUSINESS_SERVICES", "OTHER_CLOTHING", "OTHER_DIRECT_MARKETING", "OTHER_EQUIPMENT", "OTHER_HOTELS", "OTHER_PERSONAL_SERVICES", "OTHER_RENTAL_CAR", "OUTBOUND_TELEMARKETING", "PAINT", "PAINT_SUPPLIES", "PAKISTAN", "PAN_AMERICAN", "PANNONI", "PARK_INNS_INTERNATIONAL", "PARK_PLAZA_HOTEL", "PARKING_LOTS", "PATRICIA_GRAND_RESORTS", "PAWN_SHOP", "PAY_TV_SERVICES", "PAYLESS_CAR_RENTAL", "PEABODY", "PENINSULA", "PENTA", "PERIODICALS", "PERSONAL_CARE_FACILITY", "PERSONAL_COUNSELING", "PET_FOOD", "PET_STORE", "PET_SUPPLIES", "PETROLEUM", "PETROLEUM_DEALER", "PETROLEUM_PRODUCTS", "PHARMACY", "PHILATELIC_SUPPLIES", "PHILIPPINE", "PHOTO_DEVELOPING", "PHOTOCOPY_EQUIPMENT", "PHOTOCOPYING_SERVICES", "PHOTOGRAPHER", "PHOTOGRAPHER_COMMERCIAL", "PHOTOGRAPHIC_STUDIOS", "PHOTOGRAPHIC_SUPPLIES", "PHOTOGRAPHY_EQUIPMENT", "PIANO", "PIECE_GOODS", "PIECE_NOTIONS", "PLASTER_INSTALLATION", "PLUMBER_CONTRACTOR", "PLUMBING_EQUIPMENT", "PODIATRISTS", "POLISHING_PRODUCTS", "POLITICAL_ORGANIZATION", "POOL_HALL", "POOL_SUPPLIES", "POSTAL_SERVICES_GOVT_ONLY", "PRECIOUS_METALS", "PRECIOUS_STONES", "PRIMADONNA", "PRINCE", "PRINCESS", "PRINCEVILLE", "PRINTING_SERVICES_OTHER", "PRINTING_SUPPLIES", "PRIVATE_GOLF_CLUBS", "PROF_SPORTS_CLUB", "PROFESSIONAL_SCHOOLS", "PROSTHETICS", "PROTEA", "PROTECTIVE_AGENCY", "PUBLIC_GOLF_COURSES", "PUBLIC_RELATIONS", "PUBLIC_WAREHOUSING", "PUBLISHING_MISCELLANEOUS", "PULLMAN_INTERNATIONAL", "QANTAS", "QATAR", "QUALIFY_PACIFIC", "QUALITY_INNS", "QUASI_CASH_MERCHANT", "RADIO_SERVICES", "RADISSON", "RAILWAY_FREIGHT", "RAILWAYS", "RAMADA_INNS", "RANK", "RANTASIPI", "RAZOR", "RAZOR_SERVICE", "REAL_ESTATE_AGENTS", "RECORD", "RECREATIONAL_CAMP", "RECREATIONAL_TRAILER_DEALER", "RECREATIONAL_VEHICLE_RENTAL", "RED_ROOF_INNS", "REFRIGERATION", "REFRIGERATOR", "REGAL_8_INNS", "REGENT_INTERNATIONAL", "RELAX_INNS", "RELIGIOUS_ITEMS", "RELIGIOUS_ORGANIZATIONS", "RENAISSANCE", "RENO", "RENTAL_EQUIPMENT", "RENTAL_TRUCK", "RENTAL_UNIFORMS", "RENTAL_TRUCK_AND_UTILITY_TRAILER", "RENT_A_WRECK", "REPAIR_SHOPS_OTHER", "REPLACEMENT_RENT_A_CAR", "REPRODUCTIONS", "RESERVE_RENT_A_CAR", "RESIDENCE_INN", "RESIDENTIAL_CONTRACTOR", "RESO", "RESTAURANTS", "RETAIL_AND_CATALOGUE", "REUPHOLSTERER", "RICA", "RIDING_APPARELL", "RIO_HOTELS", "RIO_SUITES", "RIVIERA", "RIYADH_AIR", "ROAD_TOLLS", "ROADWAY_INNS", "ROOFER", "ROYAL", "ROYAL_AIR_MAROC", "ROYAL_DUTCH_AIRLINES_KLM", "ROYCE", "RUG", "SABENA", "SAETA", "SAHARA", "SALVAGE_YARDS", "SAMS_TOWN", "SAN_JUAN", "SANDMAN", "SANDMAN_INN", "SANDS_RESORT", "SANITATION_PRODUCTS", "SANITATION_UTILITY", "SARA", "SAROVA", "SAS", "SASHA", "SATELLITE_SERVICES", "SAUDI_ARABIAN", "SCANDIC", "SCENIC", "SCHOOL_SUPPLIES", "SCHOOLS_OTHER", "SEA_AQUARIUMS", "SEA_PINES_RESORT", "SEAMSTRESSES", "SECOND_HAND", "SECONDARY_SCHOOLS", "SECRETARIAL_SCHOOLS", "SECRETARIAL_SUPPORT", "SECURITIES", "SECURITY", "SERVICE_SHOP_CAR", "SERVICE_STATION_AUTOMATED", "SEWING", "SHANGRI_LA_INTERNATIONAL", "SHEET_METAL_WORK", "SHEET_MUSIC", "SHERATON", "SHILO_INN", "SHOE_REPAIR_SHOP", "SHOE_SHINING", "SHOES", "SHONEYS_INNS", "SHOPPING_SERVICES", "SHOWCASE_RENT_A_CAR", "SIDER", "SIERRA_SUITES", "SILVER_LEGACY", "SILVER_STAR", "SILVERWARE", "SIMMONS", "SINGAPORE", "SINGLETON", "SLEEP_INN", "SMALL_APPLIANCE", "SNAPPY_CAR_RENTAL", "SNOWMOBILE_DEALER", "SOCIAL_ASSOCIATIONS", "SOCIAL_SERVICE", "SOFITEL", "SOKOS", "SOL", "SONESTA", "SOUTH_AFRICAN", "SOUTHERN_PACIFIC", "SOUTHERN_SUN", "SOUTHWEST", "SOUVENIR", "SPANAIR", "SPECIAL_TRADE_CONTRACTOR", "SPORTING_CAMP", "SPORTING_GOODS", "SPORTS_COMMERCIAL", "SPORTS_PROMOTERS", "SPRINGHILL_SUITES", "ST_REGIS", "STAKIS", "STAMP", "STARWOOD_RESORTS", "STATIONARY", "STEIGENBERGER", "STENOGRAPHY", "STONEWORK", "SUBSCRIPTION", "SUBWAYS", "SUDAN", "SUNBELT", "SUNWORLD", "SUPER_8", "SUPERMARKET", "SURINAM", "SURVEYORS", "SWIMMING_POOLS", "SWISSAIR", "SWISSOTEL", "TACA_INTERNATIONAL", "TAILORS", "TALAIR", "TAME", "TAN", "TAP", "TAROM", "TAVERN", "TAX_PAYMENTS", "TAX_PREPARATION", "TAXIS", "TELECOM_EQUIPMENT", "TELECOM_SVC", "TELEGRAPH_SERVICES", "TELEPHONE_EQUIPMENT", "TELEPHONE_SERVICES", "TEMPORARY_HELP", "TENTS", "THAI", "THE_RITZ_CARLTON", "THE_VENETIAL", "THEATER_TICKET_AGENCIES", "THEATRICAL_PRODUCERS", "THRIFT", "THRIFTY_CAR_RENTAL", "THUNDERBIRD", "THY", "TILDEN_RENT_A_CAR", "TILE_SETTING", "TIME_SHARES", "TIRE_RETREADING_AND_REPAIR", "TIRE_SHOPS", "TOKYO", "TOKYO_INN", "TOOL_LEASING", "TOOL_RENTAL", "TOUPEE_SHOP", "TOUR_OPERATORS", "TOURIST_ATTRACTIONS", "TOWER", "TOWING", "TOWNEPLACE_SUITES", "TOYS", "TRADE_SCHOOLS", "TRAILER_PARKS", "TRAILER_RENTALS", "TRAINS_LOCAL", "TRANSAERO", "TRANSPORTATION_OTHER", "TRANSWORLD", "TRAVEL_AGENCIES", "TRAVEL_RELATED", "TRAVELODGE", "TREASURE_ISLAND", "TROPICAL_RENT_A_CAR", "TROPICANA", "TRUCK_DEALER_NEW_AND_USED", "TRUCK_DEALER_USED", "TUNIS", "TYPESETTING", "US_AIR_SHUTLE", "UGLY_DUCKLING_RENT_A_CAR", "UNIFORMS", "UNITED", "UNIVERSITIES", "UPHOLSTERY_CLEANING", "US_AIRWAYS", "USA_RENT_A_CAR", "USED_AND_NEW_AUTO_DEALER", "USED_AND_NEW_TRUCK_DEALER", "USED_AUTO_DEALER", "USED_CLOTHING", "USED_TRUCK_DEALER", "UTA", "UTILITY_TRAILER_DEALER", "VAGABOND", "VALLEY", "VALUE_RENT_A_CAR", "VANGUARD", "VARIETY_STORE", "VARIG", "VARNISH_SUPPLIES", "VASP", "VENEZOLANA_INTERNATIONAL", "VENTURE_INNS", "VETERINARY_SERVICES", "VIDEO_GAME_ARCADES", "VIDEO_GAME_SUPPLIER", "VIDEO_GAME_SUPPLIES", "VIDEO_RENTAL", "VIDEO_TAPE_PRODUCTION", "VIRGIN_ATLANTIC", "VIRGIN_RIVER", "VOCATIONAL_SCHOOLS", "W_HOTELS", "WALDORF", "WALLPAPER", "WAREHOUSES", "WATCH", "WATCHES", "WATER_UTILITY", "WELCOMGROUP", "WELDING", "WELLESLEY_INNS", "WESTIN", "WHISKEY_PETES", "WHOLESALE_CLUBS", "WIDEROES", "WIG_SHOP", "WINDOW_COVERINGS", "WINDOW_UPHOLSTERY", "WINDWARD_ISLAND", "WINE", "WINERIES", "WINGS", "WOMEN_AND_MENS_CLOTHING", "WOMENS_ACCESSORIES", "WOMENS_READY_TO_WEAR", "WOMENS_SPECIALTY_SHOP", "WOOD_DEALER", "WOODSIDE", "WRAPPING_PAPER", "WRECKERS", "ZABO", "ZOOS" ] }, "businessType": { "type": "string", "description": "The category of the business.", "enum": [ "SOLE_PROPRIETOR", "LIMITED_PARTNERSHIP", "PARTNERSHIP", "NON_PROFIT", "NON_FOR_PROFIT", "PRIVATE_CORPORATION", "PUBLIC_CORPORATION", "GOVERNMENT" ] }, "businessUrl": { "type": "string", "description": "The official website URL of the business.", "nullable": true, "format": "uri", "maxLength": 255, "example": "www.abc.com" }, "cableType": { "type": "string", "description": "Indicates the type of the cable included with the terminal device.", "nullable": true, "maxLength": 50 }, "callbackUrl": { "type": "string", "minLength": 1, "maxLength": 256, "nullable": true, "description": "URL-encoded, fully qualified callback URL that receives subscription notification.\n\nNote: Request with URL that is not URL-encoded will be rejected for security reasons.\n\nExample (URL-encoded): https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123\n", "example": "https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123" }, "cancelPaymentRequest": { "title": "cancelPaymentRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "multipleCompletion": { "nullable": true, "description": "Multiple Completion object containing amount, processedAt time, and finalCompletion flag", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" }, "finalCompletion": { "type": "boolean", "description": "Indicates whether this is the last Completion request for a Payment. To indicate that additional Completions will be performed, please pass finalCompletion as false." } }, "required": [ "amount", "processedAt", "finalCompletion" ] }, "customData": { "$ref": "#/components/schemas/customData" }, "reason": { "nullable": true, "description": "Reason for canceling the payment.\n\nNote: This is a notational field.\n", "type": "string", "minLength": 1, "maxLength": 100, "example": "Defective product" } }, "required": [ "idempotencyKey" ] }, "cancelSubscriptionRequest": { "title": "cancelSubscriptionRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "customData": { "$ref": "#/components/schemas/customData" }, "reason": { "description": "Reason for the cancellation.", "type": "string", "minLength": 1, "maxLength": 100, "example": "Defective product", "nullable": true } }, "required": [ "idempotencyKey" ] }, "card": { "type": "object", "description": "Card details", "properties": { "cardNumber": { "$ref": "#/components/schemas/cardNumber" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "cardSecurityCode": { "$ref": "#/components/schemas/cardSecurityCode" } }, "required": [ "cardNumber", "expiryMonth", "expiryYear", "cardSecurityCode" ] }, "cardAcquirer": { "type": "string", "description": "A string attribute representing the acquiring bank or institution.", "nullable": true, "maxLength": 10 }, "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" }, "cardBrandPlan": { "type": "object", "description": "An object containing the card brand plan details.", "properties": { "foreignTransactionPercentageFee": { "$ref": "#/components/schemas/foreignTransactionPercentageFee" }, "domesticTransactionPercentageFee": { "$ref": "#/components/schemas/domesticTransactionPercentageFee" }, "domesticFlatFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "foreignCardOriginCode": { "$ref": "#/components/schemas/foreignCardOriginCode" }, "domesticCardOriginCode": { "$ref": "#/components/schemas/domesticCardOriginCode" } } }, "cardBrandPlans": { "type": "array", "description": "A list of card brand items.", "items": { "$ref": "#/components/schemas/cardBrandPlan" }, "maxItems": 20 }, "cardBrandTemplateIdentifier": { "type": "string", "description": "Unique identifier that links to a predefined template associated with a specific card brand.", "nullable": true, "maxLength": 10 }, "cardFeeDetails": { "type": "object", "description": "An object containing the card fees plan details.", "nullable": true, "properties": { "authorizationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "refundAmount": { "description": "A numeric value representing the amount of money refunded to a customer under the franchise plan.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "settlementAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "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 }, "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" } } }, "cardLookup": { "title": "cardLookup", "type": "object", "properties": { "cardLookupId": { "$ref": "#/components/schemas/resourceId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "threeDSecureServerTransactionId": { "$ref": "#/components/schemas/threeDSecureServerTransactionId" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "threeDSecureVersion": { "$ref": "#/components/schemas/threeDSecureVersion" }, "threeDSecureMethodUrl": { "$ref": "#/components/schemas/threeDSecureMethodUrl" }, "threeDSecureMethodData": { "$ref": "#/components/schemas/threeDSecureMethodData" } }, "required": [ "cardLookupId", "merchantId", "paymentMethod", "threeDSecureServerTransactionId", "threeDSecureVersion", "threeDSecureMethodUrl", "threeDSecureMethodData" ] }, "cardLookupRequest": { "title": "cardLookupRequest", "description": "The card_lookup request verifies the applicability of 3DS on the card and returns the 3DS version supported by the card. It also returns the 3DS Method URL and 3DS Method Data for submitting a device fingerprinting POST to issuer’s ACS.", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodRequest" }, "threeDSecureNotificationUrl": { "$ref": "#/components/schemas/threeDSecureNotificationUrl" } }, "required": [ "idempotencyKey", "paymentMethod", "threeDSecureNotificationUrl" ] }, "cardNotPresentConfigurationCode": { "nullable": true, "type": "string", "description": "A configuration code used to identify variable settings for transactions.", "maxLength": 50 }, "cardNumber": { "type": "string", "description": "Identifies the customer's credit or debit card number (Primary Account Number).", "pattern": "^[0-9]{13,19}$", "example": "4242424242424242" }, "cardOption": { "type": "string", "description": "Specifies the type of card used or service option for a transaction plan.", "nullable": true, "maxLength": 10 }, "cardOriginCode": { "type": "string", "description": "A code that indicates the origin of the card.", "nullable": true, "enum": [ "IRAC", "IRAR", "FRGN", "FRGX", "ALL", "IERR", "ONUS", "IERX" ] }, "cardPaymentMethodInformation": { "title": "Card Payment Method Information", "description": "Details about the card used in the payment method.", "type": "object", "properties": { "paymentMethodType": { "type": "string", "description": "The type of Payment Method being used. It can be:\n - Card.\n", "enum": [ "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", "enum": [ "CARD", "TEMPORARY_TOKEN", "PERMANENT_TOKEN", "APPLE_PAY_ENCRYPTED", "APPLE_PAY_DECRYPTED", "GOOGLE_PAY_ENCRYPTED", "GOOGLE_PAY_DECRYPTED" ], "example": "TEMPORARY_TOKEN" }, "cardInformation": { "$ref": "#/components/schemas/cardInformation" }, "paymentAccountReference": { "$ref": "#/components/schemas/paymentAccountReference" }, "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" } }, "required": [ "paymentMethodType", "paymentMethodSource", "cardInformation", "storePaymentMethod" ] }, "cardReaderName": { "type": "string", "description": "The name of the card reader associated with the device.", "nullable": true }, "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.", "minLength": 3, "maxLength": 4, "example": "123" }, "cardSecurityCodeResult": { "type": "string", "nullable": true, "description": "Indicates the Card Security Code validation result.\n- **MATCH**\n- **NO_MATCH**\n- **NOT_PROCESSED**\n- **CVD_NOT_PRESENT**\n- **NOT_CVD_PRESENT**\n- **AMEX_JCB_MATCH**\n- **AMEX_JCB_INVALID**\n- **OTHER**\"\n", "enum": [ "MATCH", "NO_MATCH", "NOT_PROCESSED", "CVD_NOT_PRESENT", "NOT_CVD_PARTICIPANT", "AMEX_JCB_MATCH", "AMEX_JCB_INVALID", "OTHER", null ], "example": "MATCH" }, "cardholderInformation": { "type": "object", "description": "Information about the holder of the card.", "nullable": true, "properties": { "cardholderName": { "$ref": "#/components/schemas/cardholderName" }, "companyName": { "$ref": "#/components/schemas/companyName" } }, "required": [ "cardholderName" ] }, "cardholderName": { "type": "string", "description": "Cardholder name", "minLength": 1, "maxLength": 60, "example": "John Doe" }, "carriers": { "type": "array", "description": "A list of carrier options available for the device.", "items": { "type": "string" }, "maxItems": 10 }, "chainId": { "type": "string", "description": "A unique identifier assigned to a specific organizational chain.", "nullable": true, "minLength": 13, "maxLength": 13, "example": "0030400001622" }, "city": { "type": "string", "description": "Identifies the city.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "collectionRate": { "type": "integer", "description": "The rate at which payments are collected or deducted.", "format": "int32", "example": 10 }, "companyName": { "type": "string", "description": "Identifies the associated company name", "minLength": 1, "maxLength": 50, "example": "SP Ltd", "nullable": true }, "completionRequest": { "title": "completionRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "customData": { "$ref": "#/components/schemas/customData" }, "amount": { "nullable": true, "title": "completionAmount", "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "amountDetails": { "description": "Contains information pertaining to the surcharge amount of a Payment.", "type": "object", "nullable": true, "properties": { "surchargeAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "finalCompletion": { "type": "boolean", "description": "Indicates whether this is the last Completion request for a Payment. To indicate that additional Completions will be performed, please pass finalCompletion as false.", "default": true }, "multiCurrencyPricing": { "$ref": "#/components/schemas/multiCurrencyPricingTransactionRequest" } }, "required": [ "idempotencyKey" ] }, "confirmation": { "type": "object", "description": "An object containing the confirmation details.", "nullable": true, "properties": { "hasManualImprinter": { "type": "boolean", "description": "A boolean flag indicating whether the order requires a manual imprinter." }, "hasConsentedToCollectPersonalInformation": { "type": "boolean", "description": "A boolean flag indicating whether the user has consented to the use of their personal information." }, "isSignatureRequired": { "type": "boolean", "description": "A boolean flag indicating whether a signature is required for the order.", "default": true }, "additionalNote": { "type": "string", "description": "Additional note or comments related to the order.", "nullable": true, "maxLength": 500 } } }, "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" } }, "contactInformation": { "type": "object", "description": "An object containing all the contact details.", "required": [ "firstName", "lastName", "phone" ], "properties": { "firstName": { "$ref": "#/components/schemas/firstName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "phone": { "$ref": "#/components/schemas/phoneNumber" } } }, "convenienceFee": { "description": "Allows merchants to apply an additional charge to a customer's bill (with their consent) for the convenience of being able to pay for goods and services using an alternative payment channel.", "type": "object", "nullable": true, "properties": { "amount": { "$ref": "#/components/schemas/money" } }, "required": [ "amount" ] }, "convenienceFeeDetails": { "description": "Contains information about a Convenience Fee transaction.", "type": "object", "nullable": true, "properties": { "status": { "description": "Indicates the status of the merchant and convenience fee transactions.", "type": "string", "nullable": true, "enum": [ "COMPLETED_CONVENIENCE_FEE_TRANSACTION", "PAYMENT_COMPLETED", "COMPLETED_VOID_TRANSACTION", "COMPLETED_REFUND_TRANSACTION", "COMPLETED_MERCHANT_INDEPENDENT_REFUND_TRANSACTION", "COMPLETED_MERCHANT_REFUND_TRANSACTION", "COMPLETED_FIRST_VOID_TRANSACTION", "PAYMENT_CANCELED" ], "example": "COMPLETED_SECOND_PURCHASE_TRANSACTION" }, "amount": { "description": "The expected Convenience Fee amount.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "rate": { "description": "The Convenience Fee rate that has been defined on the merchant’s profile.", "type": "number", "format": "decimal" }, "feeType": { "description": "The type of Convenience Fee that has been defined on the merchant’s profile.", "type": "string", "enum": [ "FIXED_AMOUNT", "PERCENTAGE" ] } }, "required": [ "amount", "rate", "feeType" ] }, "counterTopTerminals": { "type": "array", "description": "A list of payment terminals available at the counter.", "items": { "$ref": "#/components/schemas/terminal" }, "maxItems": 5 }, "country": { "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" }, "createApplePayDecryptedWalletPaymentMethodRequest": { "title": "createApplePayDecryptedWalletPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/applePayDecryptedWallet" } ] }, "createApplePayEncryptedWalletPaymentMethodRequest": { "title": "createApplePayEncryptedWalletPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/applePayEncryptedWallet" } ] }, "createCardPaymentMethodRequest": { "title": "createCardPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/paymentMethodCard" } ] }, "createCustomerRequest": { "title": "customerRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "companyName": { "$ref": "#/components/schemas/companyName" }, "address": { "nullable": true, "title": "customerAddress", "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" } }, "shippingAddress": { "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" } }, "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" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey" ] }, "createGooglePayDecryptedWalletPaymentMethodRequest": { "title": "createGooglePayDecryptedWalletPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/googlePayDecryptedWallet" } ] }, "createGooglePayEncryptedWalletPaymentMethodRequest": { "title": "createGooglePayEncryptedWalletPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/googlePayEncryptedWallet" } ] }, "createIndependentRefundRequest": { "title": "Independent Refund", "description": "Independent Refund", "allOf": [ { "type": "object", "properties": { "orderId": { "$ref": "#/components/schemas/orderId" }, "paymentMethod": { "$ref": "#/components/schemas/storePaymentMethodRequest" } }, "required": [ "paymentMethod" ] }, { "$ref": "#/components/schemas/createRefundRequestBase" } ] }, "createMatchingRefundRequest": { "title": "Matching Refund", "description": "Matching Refund", "allOf": [ { "type": "object", "properties": { "paymentId": { "$ref": "#/components/schemas/paymentId" }, "multipleCompletion": { "nullable": true, "description": "Multiple Completion object containing amount, processedAt time, and finalCompletion flag", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" }, "finalCompletion": { "type": "boolean", "description": "Indicates whether this is the last Completion request for a Payment. To indicate that additional Completions will be performed, please pass finalCompletion as false." } }, "required": [ "amount", "processedAt", "finalCompletion" ] } }, "required": [ "paymentId" ] }, { "$ref": "#/components/schemas/createRefundRequestBase" } ] }, "createMerchantRequest": { "description": "Create a new merchant with the provided details.", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/merchantPayload" } ] }, "createOrderRequest": { "description": "Represents the payload for creating an order.", "oneOf": [ { "$ref": "#/components/schemas/createStandardOrderRequest" }, { "$ref": "#/components/schemas/createPartnerBankOrderRequest" } ] }, "createPartnerBankOrderRequest": { "type": "object", "description": "An object containing all the Order payload partner bank details.", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "solutions": { "$ref": "#/components/schemas/solutions" }, "deliveryAddress": { "type": "object", "nullable": true, "description": "An object containing the delivery address details.", "allOf": [ { "$ref": "#/components/schemas/address" }, { "$ref": "#/components/schemas/addressee" } ] }, "bankerInformation": { "$ref": "#/components/schemas/bankerInformation" }, "orderCreatedBy": { "$ref": "#/components/schemas/orderCreatedBy" } }, "required": [ "idempotencyKey", "solutions", "deliveryAddress", "bankerInformation" ] }, "createPaymentMethodRequest": { "title": "createPaymentMethodRequest", "oneOf": [ { "$ref": "#/components/schemas/createCardPaymentMethodRequest" }, { "$ref": "#/components/schemas/createTemporaryTokenPaymentMethodRequest" }, { "$ref": "#/components/schemas/createPermanentTokenPaymentMethodRequest" }, { "$ref": "#/components/schemas/createApplePayEncryptedWalletPaymentMethodRequest" }, { "$ref": "#/components/schemas/createApplePayDecryptedWalletPaymentMethodRequest" }, { "$ref": "#/components/schemas/createGooglePayEncryptedWalletPaymentMethodRequest" }, { "$ref": "#/components/schemas/createGooglePayDecryptedWalletPaymentMethodRequest" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "CARD": "#/components/schemas/createCardPaymentMethodRequest", "TEMPORARY_TOKEN": "#/components/schemas/createTemporaryTokenPaymentMethodRequest", "PERMANENT_TOKEN": "#/components/schemas/createPermanentTokenPaymentMethodRequest", "APPLE_PAY_ENCRYPTED": "#/components/schemas/createApplePayEncryptedWalletPaymentMethodRequest", "APPLE_PAY_DECRYPTED": "#/components/schemas/createApplePayDecryptedWalletPaymentMethodRequest", "GOOGLE_PAY_ENCRYPTED": "#/components/schemas/createGooglePayEncryptedWalletPaymentMethodRequest", "GOOGLE_PAY_DECRYPTED": "#/components/schemas/createGooglePayDecryptedWalletPaymentMethodRequest" } }, "required": [ "paymentMethodSource" ] }, "createPaymentRequest": { "title": "paymentRequest", "type": "object", "description": "Request body, used to initiate a payment", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "amount": { "description": "This amount includes the surcharge fee.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "amountDetails": { "$ref": "#/components/schemas/amountDetails" }, "convenienceFee": { "$ref": "#/components/schemas/convenienceFee" }, "customerId": { "nullable": true, "description": "The unique identifier of the customer.", "type": "string", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "paymentMethod": { "$ref": "#/components/schemas/storePaymentMethodRequest" }, "ecommerceIndicator": { "description": "Describes the category of e-commerce transaction being processed.", "type": "string", "enum": [ "MAIL_TELEPHONE_ORDER_SINGLE", "MAIL_TELEPHONE_ORDER_RECURRING", "MAIL_TELEPHONE_ORDER_INSTALMENT", "MAIL_TELEPHONE_ORDER_UNKNOWN", "AUTHENTICATED_ECOMMERCE", "NON_AUTHENTICATED_ECOMMERCE", "SSL_MERCHANT" ], "example": "AUTHENTICATED_ECOMMERCE", "default": "SSL_MERCHANT" }, "automaticCapture": { "$ref": "#/components/schemas/automaticCapture" }, "incrementalAuthorization": { "$ref": "#/components/schemas/incrementalAuthorizationIndicator" }, "customData": { "nullable": true, "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 }, "dynamicDescriptor": { "nullable": true, "type": "string", "description": "Merchant defined description sent on a per-transaction basis that will appear on the credit card statement. \n\nDependent on the card Issuer, the statement will typically show the dynamic descriptor appended to the merchant's existing business name separated by the '/' character. \n\n**Note**: The combined length of the merchant's business name, forward slash '/' character, and the dynamic descriptor may not exceed 22 characters.\n", "minLength": 1, "maxLength": 20, "example": "moneris" }, "threeDSecureData": { "$ref": "#/components/schemas/threeDSecureData" }, "installmentPlanInformation": { "$ref": "#/components/schemas/installmentPlanInformation" }, "multiCurrencyPricing": { "$ref": "#/components/schemas/multiCurrencyPricingTransactionRequest" }, "ipv4": { "$ref": "#/components/schemas/ipv4" }, "ipv6": { "$ref": "#/components/schemas/ipv6" } }, "required": [ "idempotencyKey", "paymentMethod", "amount" ] }, "createPermanentTokenPaymentMethodRequest": { "title": "createPermanentTokenPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/paymentMethodPermanentToken" } ] }, "createRefundRequest": { "title": "Create Refund Request", "oneOf": [ { "$ref": "#/components/schemas/createMatchingRefundRequest" }, { "$ref": "#/components/schemas/createIndependentRefundRequest" } ] }, "createRefundRequestBase": { "title": "Create Refund Request Base", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "refundAmount": { "$ref": "#/components/schemas/refundAmount" }, "multiCurrencyPricing": { "$ref": "#/components/schemas/multiCurrencyPricingTransactionRequest" }, "amountDetails": { "description": "Contains information pertaining to the surcharge amount of a Payment.", "type": "object", "nullable": true, "properties": { "surchargeAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "customerId": { "nullable": true, "description": "Unique Customer Identifier.", "type": "string", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "customData": { "$ref": "#/components/schemas/customData" }, "dynamicDescriptor": { "$ref": "#/components/schemas/dynamicDescriptor" }, "ipv4": { "$ref": "#/components/schemas/ipv4" }, "ipv6": { "$ref": "#/components/schemas/ipv6" }, "ecommerceIndicator": { "$ref": "#/components/schemas/ecommerceIndicator" }, "reason": { "description": "Reason for the refund.", "type": "string", "minLength": 1, "maxLength": 100, "example": "Defective product", "nullable": true } }, "required": [ "idempotencyKey", "refundAmount" ] }, "createStandardOrderRequest": { "type": "object", "description": "Represents the payload for submitting an order.", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "marketSegment": { "$ref": "#/components/schemas/marketSegment" }, "representativeCode": { "$ref": "#/components/schemas/representativeCode" }, "userDetails": { "$ref": "#/components/schemas/userDetails" }, "applicablePromotions": { "$ref": "#/components/schemas/applicablePromotions" }, "feeDetails": { "$ref": "#/components/schemas/feeDetails" }, "applicationDetails": { "$ref": "#/components/schemas/applicationDetails" }, "agreementModelInformation": { "$ref": "#/components/schemas/agreementModelInformation" }, "valueAddedServices": { "$ref": "#/components/schemas/valueAddedServices" }, "documentsStatus": { "$ref": "#/components/schemas/documentsStatus" }, "confirmation": { "$ref": "#/components/schemas/confirmation" }, "supplies": { "$ref": "#/components/schemas/supplies" }, "productDetails": { "$ref": "#/components/schemas/productDetails" }, "isAutoAdjudicationRequired": { "$ref": "#/components/schemas/isAutoAdjudicationRequired" }, "isExpeditedOrder": { "$ref": "#/components/schemas/isExpeditedOrder" }, "cardPlanDetails": { "nullable": true, "type": "object", "description": "An object containing all the card plans details.", "properties": { "merchantDiscountRateType": { "$ref": "#/components/schemas/merchantDiscountRateType" }, "currency": { "nullable": true, "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" }, "transactionFeeParameterCode": { "$ref": "#/components/schemas/transactionFeeParameterCode" }, "cardBrandTemplateIdentifier": { "$ref": "#/components/schemas/cardBrandTemplateIdentifier" }, "selectedPlans": { "$ref": "#/components/schemas/selectedPlans" }, "mastercard": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "mastercardDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visa": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visaDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "discover": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "unionPay": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "interac": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "amex": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "otherFinancialInstitutionCards": { "$ref": "#/components/schemas/otherFinancialInstitutionCards" }, "programs": { "$ref": "#/components/schemas/programs" } } }, "solutions": { "$ref": "#/components/schemas/solutions" }, "deliveryAddress": { "type": "object", "nullable": true, "description": "An object containing the delivery address details.", "allOf": [ { "$ref": "#/components/schemas/address" }, { "$ref": "#/components/schemas/addressee" } ] }, "orderCreatedBy": { "$ref": "#/components/schemas/orderCreatedBy" } }, "required": [ "idempotencyKey", "userDetails", "productDetails", "applicationDetails" ] }, "createSubscriptionRequest": { "title": "subscriptionRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "subscriptionType": { "$ref": "#/components/schemas/subscriptionType" }, "billingDetails": { "$ref": "#/components/schemas/billingDetails" }, "callbackUrl": { "$ref": "#/components/schemas/callbackUrl" }, "oneTimeAmount": { "nullable": true, "description": "The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "paymentMethod": { "$ref": "#/components/schemas/subscriptionPaymentMethodRequest" }, "ecommerceIndicator": { "$ref": "#/components/schemas/ecommerceIndicator" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "customData": { "$ref": "#/components/schemas/customData" }, "dynamicDescriptor": { "$ref": "#/components/schemas/dynamicDescriptor" }, "threeDSecureData": { "$ref": "#/components/schemas/threeDSecureData" }, "ipv4": { "$ref": "#/components/schemas/ipv4" }, "ipv6": { "$ref": "#/components/schemas/ipv6" } }, "required": [ "idempotencyKey", "paymentMethod", "subscriptionType", "billingDetails" ] }, "createTemporaryTokenPaymentMethodRequest": { "title": "createTemporaryTokenPaymentMethodRequest", "allOf": [ { "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" } }, "required": [ "idempotencyKey" ] }, { "$ref": "#/components/schemas/paymentMethodTemporaryToken" } ] }, "createValidationRequest": { "title": "Creates a Validation Request", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "paymentMethod": { "$ref": "#/components/schemas/storePaymentMethodRequest" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "dynamicDescriptor": { "$ref": "#/components/schemas/dynamicDescriptor" }, "ecommerceIndicator": { "description": "Describes the category of e-commerce transaction being processed.", "type": "string", "enum": [ "MAIL_TELEPHONE_ORDER_SINGLE", "MAIL_TELEPHONE_ORDER_RECURRING", "MAIL_TELEPHONE_ORDER_INSTALMENT", "MAIL_TELEPHONE_ORDER_UNKNOWN", "AUTHENTICATED_ECOMMERCE", "NON_AUTHENTICATED_ECOMMERCE", "SSL_MERCHANT" ], "example": "AUTHENTICATED_ECOMMERCE", "default": "SSL_MERCHANT" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey", "paymentMethod" ] }, "createdAt": { "description": "Time at which the object was created", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "credentialOnFileInformation": { "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } }, "credentialOnFileResponse": { "type": "object", "nullable": true, "description": "Contains fields related to the Credential on File (CoF) ", "properties": { "originalAmount": { "$ref": "#/components/schemas/originalAmount" }, "issuerId": { "$ref": "#/components/schemas/issuerId" } } }, "creditTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through credit-based payments.", "format": "int32" }, "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" }, "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 }, "customer": { "title": "customer", "type": "object", "properties": { "customerId": { "$ref": "#/components/schemas/customerId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "companyName": { "$ref": "#/components/schemas/companyName" }, "address": { "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" } }, "shippingAddress": { "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" } }, "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" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "customerId", "merchantId", "createdAt" ] }, "customerId": { "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerList": { "title": "customerList", "type": "object", "properties": { "data": { "description": "List of customers.", "type": "array", "items": { "$ref": "#/components/schemas/customer" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "customerRequest": { "title": "customerRequest", "type": "object", "properties": { "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "companyName": { "$ref": "#/components/schemas/companyName" }, "address": { "nullable": true, "title": "customerAddress", "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" } }, "shippingAddress": { "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" } }, "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" }, "customData": { "$ref": "#/components/schemas/customData" } } }, "dataType": { "type": "string", "description": "Only available to Canada integrations.\n\nApplies to merchants using their own API for transaction payload encryptions and is mandatory for INTERAC® e-Commerce Apple Pay and Google Pay transactions.\n", "enum": [ "THREE_D_SECURE", "EMV" ] }, "dateTime": { "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z", "description": "Date & Time" }, "depositType": { "type": "string", "description": "Indicates the type of deposit arrangement for the merchant account.", "nullable": true, "maxLength": 10 }, "deviceManufacturerIdentifier": { "type": "string", "description": "Hex-encoded device manufacturer identifier", "nullable": true }, "deviceName": { "type": "string", "description": "The name of the device.", "nullable": true }, "directSellingPercentage": { "description": "The percentage of transactions processed through direct selling.", "type": "number", "format": "decimal", "minimum": 0, "maximum": 100, "example": 90.5 }, "discoverTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through Discover payments.", "format": "int32", "example": 1000 }, "dispute": { "description": "Dispute information for specific case.", "type": "object", "required": [ "caseRecordNumber", "caseId", "documents" ], "properties": { "imageUploadAllowed": { "description": "Indicates whether documents may or may not be uploaded for the case.", "type": "boolean" }, "acceptAllowed": { "description": "Indicates whether acceptance is permitted for the case.", "type": "boolean" }, "caseRecordNumber": { "description": "The record number of the case associated with the uploaded files.", "type": "string" }, "caseId": { "description": "The case ID of the uploaded files.", "type": "string" }, "documents": { "description": "List of evidence documents for the dispute.", "type": "array", "items": { "$ref": "#/components/schemas/disputeDocument" } } } }, "disputeDocument": { "description": "Return the image details for the specific case.", "type": "object", "required": [ "receivedAt", "fileName", "images" ], "properties": { "receivedAt": { "description": "Date when the original image received.", "type": "string", "format": "date-time" }, "fileName": { "description": "Name of the image file.", "type": "string" }, "totalPages": { "description": "Number of pages in the file.", "type": "integer", "format": "int32" }, "images": { "description": "Images.", "type": "array", "items": { "type": "object", "required": [ "image" ], "properties": { "image": { "description": "Image file.", "type": "string", "format": "base64url" }, "pageNo": { "description": "Page number.", "type": "integer", "format": "int32" } } } } } }, "disqualifiedTransactionMerchantDiscountRate": { "type": "number", "description": "The merchant discount rate applied to transactions that do not meet certain qualifying criteria under the transaction plan.", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "documentsStatus": { "type": "object", "description": "An object containing the documents status details.", "nullable": true, "properties": { "creditDocumentsStatus": { "type": "array", "description": "A list of document statuses for the order.", "items": { "type": "object", "properties": { "documentName": { "type": "string", "nullable": true, "description": "The type of the document status.", "maxLength": 100, "enum": [ "ADVERTISING", "ALCOHOL_CARD_NOT_PRESENT_OFFICER_CERTIFICATE", "ALCOHOL_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "APPLICABLE_LICENCE", "BUSINESS_REGISTRATION_DOCUMENTS", "CAF", "CANNABIS_ATTESTATION", "FIREARMS_CARD_NOT_PRESENT_OFFICER_CERTIFICATE", "FIREARMS_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "FINANCIAL_STATEMENTS", "LEGAL_OPINION_LETTER", "MASTER_CARD_MRP_REGISTRATION", "MEDICAL_DENTAL_EQUIPMENT_CARD_NOT_PRESENT_OFFICER_CERTIFICATE", "MEDICAL_DENTAL_EQUIPMENT_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "OFFICER_CERTIFICATE", "OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "ORGANIZATION_CHART", "PG", "PHARMACY_CARD_NOT_PRESENT_OFFICER_CERTIFICATE", "PHARMACY_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "POLITICAL_ORGANIZATION_REGISTRATION", "PREVIOUS_PROCESSING_STATEMENTS", "PSNW", "SMOKING_SUPPLIES_CARD_NOT_PRESENT_OFFICER_CERTIFICATE", "SMOKING_SUPPLIES_CARD_NOT_PRESENT_OFFICER_CERTIFICATE_SOLE_PROPRIETOR", "VISA_HBR_REGISTRATION" ] }, "documentStatus": { "type": "string", "nullable": true, "description": "The name of the selection associated with the document.", "maxLength": 100 } } }, "maxItems": 40 }, "additionalDocumentsStatus": { "type": "array", "description": "A list of additional document status associated with the order.", "maxItems": 50, "items": { "type": "object", "properties": { "documentName": { "type": "string", "nullable": true, "description": "The type of the additional document status.", "maxLength": 6, "enum": [ "AMEX_ELIGIBILITY_VERIFICATION", "CONTROL_VERIFICATION", "MASSAGE_LICENSE_NUMBER", "MERCHANT_CONFIRMATION", "REGISTRATION_NUMBER", "TICO_IATA_NUMBER" ] }, "documentStatus": { "type": "string", "nullable": true, "description": "The status of the selection associated with the document input.", "maxLength": 100 }, "additionalComment": { "nullable": true, "type": "string", "description": "Comment associated with the additional document.", "maxLength": 100 } } } } } }, "domesticCardOriginCode": { "type": "string", "description": "A code used to identify the origin of a domestic card in a transaction under the card brand plan.", "nullable": true, "maxLength": 10 }, "domesticTransactionPercentageFee": { "type": "number", "description": "The percentage fee applied to transactions involving domestic cards or payments within the same country.", "default": 0, "format": "float", "minimum": 0, "maximum": 100 }, "dropShipping": { "type": "boolean", "description": "A boolean value indicating whether the business engages in drop shipping as part of its operations." }, "dynamicDescriptor": { "type": "string", "description": "Merchant defined description sent on a per-transaction basis that will appear on the credit card statement. \n\nDependent on the card Issuer, the statement will typically show the dynamic descriptor appended to the merchant's existing business name separated by the '/' character. \n\n**Note**: The combined length of the merchant's business name, forward slash '/' character, and the dynamic descriptor may not exceed 22 characters.\n", "minLength": 1, "maxLength": 20, "example": "moneris", "nullable": true }, "ecommerceIndicator": { "type": "string", "description": "The ecommerce indicator (ECI) specifies the level of security that was used to obtain the cardholder's payment data. \nIt is sent by the merchant and returned by the issuer.\nWhen returned in the response, it can be different from the value sent in the request in case transaction was downgraded by the issuer.\n", "enum": [ "MAIL_TELEPHONE_ORDER_SINGLE", "MAIL_TELEPHONE_ORDER_RECURRING", "MAIL_TELEPHONE_ORDER_INSTALMENT", "MAIL_TELEPHONE_ORDER_UNKNOWN", "AUTHENTICATED_ECOMMERCE", "NON_AUTHENTICATED_ECOMMERCE", "SSL_MERCHANT" ], "example": "AUTHENTICATED_ECOMMERCE", "default": "SSL_MERCHANT" }, "ecommerceTransactionPercentage": { "description": "The percentage of transactions processed through e-commerce.", "type": "number", "format": "decimal", "minimum": 0, "maximum": 100, "example": 90.5 }, "email": { "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" }, "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" ] }, "evaluateKountResult": { "description": "full re-evaluation will be performed with Kount. Default to false.", "type": "boolean", "default": false, "example": false }, "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 }, "extendSubscriptionRequest": { "type": "object", "description": "Adds the given number of subscription transactions to the current (remaining) number. This can be used if a customer decides to extend a membership/subscription. However, because this must be a positive number, it cannot be used to decrease the current number of subscription transactions.", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "additionalSubscriptionIntervalCount": { "description": "Adds the given number of subscription transactions to the current (remaining) number. This can be used if a customer decides to extend a membership/subscription. However, because this must be a positive number, it cannot be used to decrease the current number of subscription transactions.", "type": "integer", "format": "int32", "minimum": 1, "maximum": 99, "example": 12 }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey", "additionalSubscriptionIntervalCount" ] }, "feeDetails": { "type": "object", "description": "An object containing the fees details", "nullable": true, "properties": { "accountServiceFee": { "description": "A fee charged for maintaining the account associated with the order.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "consolidatedAccountServiceFee": { "description": "A combined or aggregated fee charged for the maintenance of consolidated accounts.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "minimumMerchantDiscountRateFee": { "description": "The minimum Merchant Discount Rate that applies to a transaction.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "paperStatementFee": { "description": "A fee charged for receiving paper statements.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "pciSecurityFee": { "description": "A fee charged to cover the costs of ensuring compliance with the Payment Card Industry Data.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "totalAdminFee": { "description": "The total administrative fee applied to an order.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "upgradeFee": { "description": "A fee charged for upgrading a product to a newer version.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "agedCloseBatchFee": { "description": "A fee charged when a batch of transactions remains open beyond a defined period without being settled.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "mastercardComplianceFee": { "description": "A fee associated with ensuring compliance with MasterCard's regulatory.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "dialCommunicationFee": { "description": "A fee charged for using dial-up communication methods to transmit transaction data.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "handlingFee": { "description": "A fee charged to cover the costs associated with the preparation and processing of an order.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "chargeBackFee": { "description": "A fee applied when a chargeback is initiated by a customer.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "consolidation": { "description": "A fee charged for combining multiple services or transactions into a single package.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "feeType": { "type": "string", "description": "Specifies the category or purpose of the fee applied to a transaction or service.", "nullable": true, "maxLength": 30 }, "feeTypeCode": { "type": "string", "description": "A code that identifies the type of fee associated with a transaction.", "nullable": true, "enum": [ "ACCESS_POINT_CHARGE_FOR_VISA", "AFD_PRE_AUTHORIZATION_TEST_FEE", "AMEX_INBOUND_FEE", "AMEX_JCB_PARTICIPATION_FEE", "CARD_BRAND_FEES", "CARD_BRAND_MAINTENANCE_FEE", "CNP_MANUAL_ENTRY_FEE", "CONSUMER_BILL_PAYMENT_SERVICE", "DISCOVER_ASSESSMENT_FEE", "DISCOVER_INTERNATIONAL_PROCESS", "DISPUTE_ADJUSTMENT", "DO_NOT_USE", "DO_NOT_USE_ERROR_SET_UP", "DO_NOT_USE_REDUNDANT", "ELECTRONIC_COMMERCE_FEE", "FACILITY_USE_FEE", "GATEWAY_TRANSACTION_FEE", "HAULAGE_FEE", "HIGH_RISK_TRANSACTION_FEE", "INSTALLMENT_ELIGIBILITY", "INSTALLMENT_FUNDING", "INSTALLMENT_TRANSACTION", "INTERAC_ASSESSMENT_FEE", "INTERAC_DIRECT_ASSESSMENT", "INTERAC_ONLINE_FEE", "IVR_TRANSACTION_FEE", "KIOSK_TRANSACTION_FEE", "MASTERCARD_ACQUIRER_LICENSE_FEE", "MASTERCARD_ASSESSMENT_FEE", "MASTERCARD_ASSESSMENT_FEE_FOREIGN", "MASTERCARD_ASSESSMENT_TRANSACTION_FEE_CREDIT", "MASTERCARD_FLEX_PROGRAM_FEE", "MASTERCARD_FREIGHT_ASSESSMENT", "MASTERCARD_GL_WH_TRAVEL_TRANSACTION_PROGRAM_B2B_FEE", "MASTERCARD_HUMANITARIAN_ASSESSMENT", "MASTERCARD_INTERNATIONAL_TRANSACTION_PROCESSING_FEE", "MASTERCARD_MAIL_PHONE_ORDER", "MASTERCARD_PRE_AUTHORIZATION_AFD", "MASTERCARD_PRE_AUTHORIZATION_AFD_MINIMUM", "MASTERCARD_SAFETY_NET_ACQUIRER_FEE", "MDR_PROCESSING_FEE", "MONERIS_MARKETPLACE_SERVICE", "NETWORK_CONNECTIVITY_FEE", "NON_QUALIFIED_FEE", "OPERATOR_ADMINISTRATION", "P2PE_BLUEFIN_SOLUTION", "P2PE_COSTCO_BLUEFIN_SOLUTION", "P2PE_MONERIS_SOLUTION", "P2PE_TRANSACTION_FEE", "PARTNER_TRANSACTION_FEE", "REFUND_TRANSACTION_FEE", "RETURN_ADJUSTMENT", "ROYALTY_FEE", "SETTLEMENT_FEE", "SOFTPOS_TAP_TO_PAY", "STERLING_INTERAC_REMUNERATION", "SURCHARGE_ENABLEMENT_FEE", "SURCHARGE_FEE", "TEST_FEE", "THREE_DS_AUTHENTICATION_FEE", "UNIONPAY_SERVICE_FEE", "VAR_TRANSACTION_FEE", "VISA_ASSESSMENT_FEE", "VISA_B2B_VIRTUAL_SERVICE_FEE", "VISA_COMMERCIAL_SOLUTIONS_ASSISTANCE", "VISA_DIRECT_ASSESSMENT_FEE", "VISA_FOREIGN_ASSESSMENT", "VISA_FOREIGN_FEE", "VISA_MCP_NON_DOMESTIC_CHARGE", "VISA_NON_DOMESTIC_SETTLEMENT", "VISA_SYSTEM_ACCESS_FEE" ] }, "financialOrderId": { "description": "Unique identifier for transactions at Kount", "type": "string", "maxLength": 32, "example": "nqa-finorderid-1", "nullable": true }, "first": { "description": "Pagination link pointing to the first page.", "type": "string", "format": "uri-reference", "nullable": true }, "firstInstallment": { "type": "object", "description": "Cost details (fee and principal) for the first Installment.", "properties": { "installmentUpFrontFee": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "installmentFee": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "installmentAmount": { "$ref": "#/components/schemas/money" } }, "required": [ "installmentAmount" ] }, "firstName": { "type": "string", "description": "First name.", "minLength": 1, "maxLength": 30, "example": "John", "nullable": true }, "foreignCardOriginCode": { "type": "string", "description": "A code used to identify the origin of a foreign card in a transaction under the card brand plan.", "nullable": true, "maxLength": 10 }, "foreignTransactionPercentageFee": { "type": "number", "description": "The percentage fee applied to transactions involving foreign cards.", "default": 0, "format": "float", "minimum": 0, "maximum": 100 }, "fraudScore": { "description": "Final risk score returned from Kount system", "type": "integer", "format": "int32", "maxLength": 3, "example": 99, "nullable": true }, "fullName": { "type": "string", "description": "Customers full name", "minLength": 1, "maxLength": 64, "example": "John Doe", "nullable": true }, "gender": { "type": "string", "nullable": true, "description": "An individual's gender", "enum": [ "MALE", "FEMALE", null ] }, "googlePayDecryptedCardDetails": { "description": "The payment credential itself. The format of this object is determined by the paymentMethod\n", "type": "object", "properties": { "personalAccountNumber": { "description": "The personal account number charged. This string contains only digits.", "type": "string", "pattern": "^[0-9]{13,19}$", "example": "4242424242424242" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "authenticationMethod": { "description": "The authentication method of the card transaction.\nMust be forwarded as provided by Google Pay.\n", "type": "string", "nullable": true }, "cryptogram": { "nullable": true, "type": "string", "description": "Token cryptogram or encoded Base64 for Interac Wallets.", "maxLength": 500, "example": "8YGKgiD0iJic84fBLVj3QuwuclqLp7QvizbKnGRYAMVfVwBobYMBAIQBAIUBAIZTWgpQdgQQKZkZFHGfXySDKRAxXyoCASSfAgYAAAAQAABfIAIgL58ZBgSSSSSSSL9JIoEgAAMj1qj1U9jsORa1qxqAEAHOBAAEAECKALEAAAADEACHCAAAAAAAAAAAkAA=" }, "walletEcommerceIndicator": { "$ref": "#/components/schemas/walletEcommerceIndicator" } }, "required": [ "personalAccountNumber", "expiryMonth", "expiryYear" ] }, "googlePayDecryptedWallet": { "title": "googlePayDecryptedWallet", "description": "Google Pay wallet details after decrypting the token.", "allOf": [ { "$ref": "#/components/schemas/paymentMethodRequestBase" }, { "type": "object", "properties": { "gatewayMerchantId": { "nullable": true, "type": "string", "description": "Gateway unique store id", "example": "cagw123456" }, "messageExpiration": { "type": "string", "nullable": true, "format": "date-time", "description": "Date and time at which the message expires. Integrators should reject any message that's expired.\n", "example": "2024-09-19T00:00:00Z" }, "messageId": { "type": "string", "nullable": true, "description": "A unique ID that identifies the message in case it needs to be revoked or located at a later time." }, "walletSource": { "type": "string", "description": "The type of the payment credential. Supported values are:\n - CARD\n - TOKENIZED_CARD\n", "enum": [ "CARD", "TOKENIZED_CARD" ] }, "cardBrand": { "type": "string", "description": "Card Network.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "INTERAC" ] }, "walletIndicator": { "$ref": "#/components/schemas/walletIndicator" }, "cardDetails": { "$ref": "#/components/schemas/googlePayDecryptedCardDetails" } }, "required": [ "walletSource", "cardBrand", "cardDetails", "walletIndicator" ] } ], "required": [ "paymentMethodSource" ] }, "googlePayEncryptedWallet": { "title": "googlePayEncryptedWallet", "description": "Apple Pay encrypted wallet details.", "allOf": [ { "$ref": "#/components/schemas/paymentMethodRequestBase" }, { "type": "object", "properties": { "cardBrand": { "type": "string", "description": "Card Brand.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "INTERAC" ], "example": "INTERAC" }, "signature": { "type": "string", "description": "Verifies that the message came from Google. It's base64-encoded, and created with ECDSA by the intermediate signing key.\n" }, "googlePayProtocolVersion": { "type": "string", "description": "Identifies the encryption or signing scheme under which the message is created. \nIt allows the protocol to evolve over time, if needed.\nMust be fowarded as provided by Google Pay.\n", "example": "ECv1" }, "signedMessage": { "type": "string", "description": "A JSON object serialized as an HTML-safe string that contains the encryptedMessage, ephemeralPublicKey, and tag. It's serialized to simplify the signature verification process.\n" }, "walletIndicator": { "$ref": "#/components/schemas/walletIndicator" } }, "required": [ "cardBrand", "signature", "googlePayProtocolVersion", "signedMessage", "walletIndicator" ] } ], "required": [ "paymentMethodSource" ] }, "hasExistingRelationship": { "type": "boolean", "description": "A boolean value indicating whether the business has an existing relationship with the service provider." }, "hasMajorityOwnership": { "type": "boolean", "description": "A boolean value indicating whether the business has majority ownership." }, "hasMultipleLocations": { "type": "boolean", "description": "A boolean value indicating whether the business has multiple locations." }, "idempotencyKey": { "type": "string", "description": "A Unique Identifier that is required for handling idempotent requests. \n\nNote: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key.\" \n", "minLength": 1, "maxLength": 36, "example": "6q5w4e7r8t9y" }, "incrementalAuthorization": { "description": "Incremental Authorization object containing amount and processedAt time.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" } }, "required": [ "amount", "processedAt" ] }, "incrementalAuthorizationIndicator": { "type": "boolean", "description": "This flag is used for processing the Pre-Authorization transaction as an Incremental Authorization transaction.", "default": false }, "incrementalAuthorizationRequest": { "title": "incrementalAuthorization", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "amount": { "description": "This amount excludes surcharge, application and converience fee.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey", "amount" ] }, "incrementalAuthorizations": { "description": "List of all previous incremental authorizations.", "type": "array", "items": { "$ref": "#/components/schemas/incrementalAuthorization" } }, "installationType": { "type": "string", "description": "Specifies the method or environment of terminal installation.", "nullable": true, "maxLength": 50, "enum": [ "ONSITE_PREMIUM_INSTALLATION", "ONSITE_PRO_INSTALLATION", "ONSITE_STANDARD_INSTALLATION", "ONSITE", "MERCHANT_INSTALL", "PHONE" ] }, "installmentAcceptanceId": { "type": "string", "description": "Visa-generated identifier for a plan acceptance.", "minimum": 36, "maximum": 36, "example": "56d58423-ea25-64e0-ddf3-1e1133549801" }, "installmentCount": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 1000, "description": " Maximum number of installments that can be in the Plan Acceptance created from this plan.", "example": 6 }, "installmentEligibilityRequest": { "type": "object", "description": "Installment Eligibility request.", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "amount": { "$ref": "#/components/schemas/money" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodRequest" } }, "required": [ "idempotencyKey", "amount", "paymentMethod" ] }, "installmentEligibilityResponse": { "type": "object", "description": "Installment Eligibility response.", "properties": { "installmentPlans": { "description": "List of eligible plans.", "type": "array", "items": { "$ref": "#/components/schemas/installmentPlan" } }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" } }, "required": [ "installmentPlans", "paymentMethod" ] }, "installmentFrequency": { "type": "string", "description": "Supported Tenure Types for a plan.", "enum": [ "WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY" ], "example": "MONTHLY" }, "installmentId": { "type": "string", "description": "Visa-generated identifier for an Installment plan.", "minLength": 36, "maxLength": 36, "example": "130d93f9-8a5d-a78c-4741-14905057ce01" }, "installmentIdReference": { "type": "string", "description": "A Visa-generated, alphanumeric, unique, and short human-readable friendly name for Installment Plan.", "minLength": 10, "maxLength": 10, "example": "0000000063" }, "installmentName": { "type": "string", "description": "Name of the installment plan. This may not be unique.", "example": "Plan6M" }, "installmentPlan": { "type": "object", "description": "Installment plan details.", "properties": { "planId": { "$ref": "#/components/schemas/installmentId" }, "planIdReference": { "$ref": "#/components/schemas/installmentIdReference" }, "planName": { "$ref": "#/components/schemas/installmentName" }, "planType": { "$ref": "#/components/schemas/installmentType" }, "installmentCount": { "$ref": "#/components/schemas/installmentCount" }, "installmentFrequency": { "$ref": "#/components/schemas/installmentFrequency" }, "planTermsAndConditions": { "type": "array", "description": "Terms and Conditions for the Installment Plan.", "items": { "type": "object", "$ref": "#/components/schemas/installmentTermsAndConditions" } }, "installmentPromotionCode": { "$ref": "#/components/schemas/installmentPromotionCode" }, "installmentPromotionId": { "$ref": "#/components/schemas/installmentPromotionId" }, "firstInstallment": { "$ref": "#/components/schemas/firstInstallment" }, "lastInstallment": { "$ref": "#/components/schemas/lastInstallment" }, "annualPercentageRate": { "description": "Annual Percentage Rate (APR) as configured by the Issuer during plan creation. This is not used for calculations but used only for display purposes.", "type": "number", "format": "decimal", "multipleOf": 0.01, "minimum": 0, "maximum": 100, "example": 90.5 }, "installmentTotalFee": { "$ref": "#/components/schemas/money" }, "totalPlanCost": { "$ref": "#/components/schemas/money" } }, "required": [ "planId", "planIdReference", "planName", "planType", "installmentCount", "installmentFrequency", "planTermsAndConditions", "installmentPromotionCode", "installmentPromotionId", "firstInstallment", "lastInstallment", "annualPercentageRate", "installmentTotalFee", "totalPlanCost" ] }, "installmentPlanDetails": { "type": "object", "description": "Installment plan application results.", "nullable": true, "properties": { "planId": { "$ref": "#/components/schemas/installmentId" }, "planIdReference": { "$ref": "#/components/schemas/installmentIdReference" }, "planTermsAndConditionsVersion": { "$ref": "#/components/schemas/installmentTermsAndConditionsVersion" }, "planAcceptanceId": { "$ref": "#/components/schemas/installmentAcceptanceId" }, "planStatus": { "$ref": "#/components/schemas/installmentStatus" }, "planProcessingResponseMessage": { "nullable": true, "type": "string", "description": "Installment plan processing response", "minLength": 2, "maxLength": 50 } }, "required": [ "planId", "planIdReference", "planTermsAndConditionsVersion", "planAcceptanceId", "planStatus" ] }, "installmentPlanInformation": { "type": "object", "description": "Installment plan details, if an installment plan is selected", "nullable": true, "properties": { "planId": { "$ref": "#/components/schemas/installmentId" }, "planIdReference": { "$ref": "#/components/schemas/installmentIdReference" }, "planTermsAndConditionsVersion": { "$ref": "#/components/schemas/installmentTermsAndConditionsVersion" } }, "required": [ "planId", "planIdReference", "planTermsAndConditionsVersion" ] }, "installmentPromotionCode": { "type": "string", "description": "An external identifier to this plan provided by the issuer to Visa that identifies this Installment plan.", "nullable": true, "minLength": 1, "maxLength": 2 }, "installmentPromotionId": { "nullable": true, "type": "string", "description": "An external identifier provided by the issuer to Visa that identifies a program or promotion that is setup outside of Visa Installment Services.", "minLength": 1, "maxLength": 8, "example": "02226M1" }, "installmentStatus": { "type": "string", "description": "Status of the Installment Plan.", "enum": [ "ACCEPTED", "NEW", "CANCELED" ], "example": "ACCEPTED" }, "installmentTermsAndConditions": { "type": "object", "properties": { "installmentTermsAndConditionsText": { "$ref": "#/components/schemas/installmentTermsAndConditionsText" }, "installmentTermsAndConditionsUrl": { "$ref": "#/components/schemas/url" }, "installmentTermsAndConditionsVersion": { "$ref": "#/components/schemas/installmentTermsAndConditionsVersion" }, "installmentTermsAndConditionsLanguageCode": { "$ref": "#/components/schemas/language" } }, "required": [ "installmentTermsAndConditionsText", "installmentTermsAndConditionsUrl", "installmentTermsAndConditionsVersion", "installmentTermsAndConditionsLanguageCode" ] }, "installmentTermsAndConditionsText": { "type": "string", "description": "Text of the Terms and Conditions for Installment Plan.", "minLength": 1, "maxLength": 2000, "example": "You are selecting a 6-month installment plan." }, "installmentTermsAndConditionsVersion": { "type": "string", "description": "Installment Plan Terms and Conditions Version. Version of the Terms & Conditions accepted by the consumer. The version is auto-incremented every time an update is made to the Plan by the issuer.", "minLength": 1, "maxLength": 2147483647, "example": "1" }, "installmentType": { "type": "string", "description": "Type of the installment plan.", "enum": [ "BILATERAL", "ISSUER_DEFAULT", "ISSUER_PROMOTION", "MARKET" ], "example": "ISSUER_PROMOTION" }, "installmentsFeeDetails": { "type": "object", "description": "An object representing the fees associated with installment payments.", "nullable": true, "properties": { "monerisVisaInstallmentsFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaInstallmentsAccessFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "institutionNumber": { "type": "string", "description": "The name or identifier of the financial institution.", "maxLength": 5, "example": 809, "pattern": "^\\d{5}" }, "integratedProduct": { "type": "object", "description": "An object containing details about the integrated product.", "nullable": true, "properties": { "variableConfigurationCode": { "type": "string", "description": "A configuration code used to identify variable settings for transactions.", "maxLength": 50, "nullable": true }, "cardPresentVariableConfigurationCode": { "type": "string", "description": "A configuration code used to identify card present settings for transactions.", "maxLength": 50, "nullable": true }, "cardNotPresentVariableConfigurationCode": { "type": "string", "description": "A configuration code used to identify card not present settings for transactions.", "maxLength": 50, "nullable": true }, "cardPresentVariableConfigurationCodeSelectionName": { "type": "string", "description": "A string representing the variable code selection for the integrated product.", "maxLength": 50, "nullable": true }, "cardNotPresentVariableConfigurationCodeSelectionName": { "type": "string", "description": "A string representing the variable code selection for the integrated product.", "maxLength": 50, "nullable": true }, "integrationFeesDetails": { "type": "object", "description": "An object representing the fees associated with the integrated product.", "nullable": true, "properties": { "creditFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "integrationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "pointOfSalePadsFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaBypassVerificationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "touchBistroTrainingFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "tokenSharingSetupFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultPerTransactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "cloudAccessFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "kioskTransactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "p2peFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "p2peIndoorFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "p2peOutdoorFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "p2pePerTransactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "terminals": { "type": "array", "description": "A list of payment terminals available for the integrated product.", "items": { "$ref": "#/components/schemas/terminal" }, "maxItems": 21 }, "creditElectronicCashRegistersQuantity": { "type": "integer", "description": "A number representing the quantity of electronic cash registers used for credit transactions.", "format": "int32", "minimum": 1, "maximum": 100 }, "debitElectronicCashRegistersQuantity": { "type": "integer", "description": "A number representing the quantity of electronic cash registers used for debit transactions.", "format": "int32", "minimum": 1, "maximum": 100 }, "debitCreditElectronicCashRegistersQuantity": { "type": "integer", "description": "A number representing the quantity of electronic cash registers used for both debit and credit transactions.", "format": "int32", "minimum": 1, "maximum": 100 }, "storeAndForwardCreditElectronicCashRegistersQuantity": { "type": "integer", "description": "A number representing the quantity of electronic cash registers used for store and forward credit transactions.", "format": "int32", "minimum": 1, "maximum": 100 }, "storeAndForwardDebitElectronicCashRegistersQuantity": { "type": "integer", "description": "A number representing the quantity of electronic cash registers used for store and forward debit transactions.", "format": "int32", "minimum": 1, "maximum": 100 } } }, "interacTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through Interac payments.", "format": "int32", "example": 1000 }, "invoiceNumber": { "type": "string", "description": "Submits a unique value to identify a transaction that is logged by Moneris Solutions.\n", "minLength": 1, "maxLength": 17, "example": "1a2s3d45v6", "nullable": true }, "ipv4": { "type": "string", "format": "ipv4", "description": "Internet Protocol version 4 (IPv4).", "example": "104.75.173.179", "nullable": true }, "ipv6": { "type": "string", "format": "ipv6", "description": "Internet Protocol version 6 (IPv6).", "example": "2600:1401:2::8a", "nullable": true }, "isAllowedToSell": { "type": "boolean", "description": "A boolean value indicating whether the business is allowed to sell the solution." }, "isApproved": { "type": "boolean", "description": "A boolean flag to indicate whether the fee has been approved for inclusion in the transaction.", "example": true }, "isAutoAdjudicationRequired": { "type": "boolean", "description": "A boolean flag indicating whether the auto adjudication process is required." }, "isCommunicationsOptOut": { "type": "boolean", "description": "A boolean flag indicating whether the customer has opted out of receiving communications related to a franchise plan." }, "isExpeditedOrder": { "type": "boolean", "description": "A boolean flag indicating whether an order is being processed as a rush or expedited order." }, "isInstore": { "type": "boolean", "description": "A boolean value indicating whether the solution is available for in-store transactions." }, "isOnline": { "type": "boolean", "description": "A boolean value indicating whether the solution is available for online transactions." }, "isSeasonalMerchant": { "type": "boolean", "description": "A boolean value indicating whether the business operates seasonally." }, "iso": { "type": "string", "description": "Represents the Moneris response code for the equivalent International Organization for Standardization (ISO) response code.", "minLength": 2, "maxLength": 2, "example": "00" }, "issuer": { "type": "string", "description": "Card issuer.", "minLength": 1, "maxLength": 100, "example": "RBC", "nullable": true }, "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 }, "itemId": { "type": "string", "maxLength": 255, "description": "Item unique identifier.", "example": "e2ab873e-b295-11e9-9c02" }, "itemType": { "type": "string", "description": "High level description of an item", "maxLength": 255, "example": "Phone" }, "kioskReference": { "type": "string", "description": "Identifies the specific kiosk associated with the terminal.", "nullable": true, "maxLength": 50 }, "kountAccountId": { "description": "6 digit local identifier used by the merchant to identify the kount inquiry request", "type": "string", "minLength": 6, "maxLength": 6, "example": "760000" }, "kountApiKey": { "description": "The API key for the associated with the Kount Merchant ID", "type": "string", "maxLength": 256, "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI3NjAwMDAiLCJhdWQiOiJLb3VudC4xIiwiaWF0IjoxNTU4MDQwODQ5LCJzY3AiOnsia2EiOm51bGwsImtjIjpmYWxzZSwiYXBpIjp0cnVlLCJyaXMiOnRydWV9fQ.y3_2yzd11-Y_F6_xzVsXI-NO1a7P6ldMjDnKzl5yBko" }, "kountAssertRequest": { "title": "kountAssertRequest", "type": "object", "properties": { "kountAccountId": { "$ref": "#/components/schemas/kountAccountId" }, "kountApiKey": { "$ref": "#/components/schemas/kountApiKey" }, "paymentDetails": { "title": "kountAssertPaymentDetails", "description": "Kount Assert Payment Data", "oneOf": [ { "$ref": "#/components/schemas/kountPaymentId" }, { "type": "object", "properties": { "validationId": { "$ref": "#/components/schemas/resourceId" } }, "required": [ "validationId" ] }, { "type": "object", "title": "Kount Assert Payment Data", "description": "Kount Assert Payment Data", "properties": { "lastFour": { "nullable": true, "type": "string", "description": "Last 4 digits of the card.", "minLength": 4, "maxLength": 4, "example": "1234" }, "paymentToken": { "nullable": true, "description": "Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MICR, and account number).\n\nIf paymentType is set to NONE then the paymentToken value should be left empty (NULL).\n\nIf the credit card information is not available and Moneris Tokenization is used to process payment set paymentType = CARD and send the token in the paymentToken field.\n", "type": "string", "maxLength": 32, "example": "4242424242424242" }, "paymentType": { "$ref": "#/components/schemas/paymentType" } }, "required": [ "paymentType" ] } ] }, "financialOrderId": { "nullable": true, "description": "Unique identifier for transactions at Kount", "type": "string", "maxLength": 32, "example": "nqa-finorderid-1" }, "refundStatus": { "$ref": "#/components/schemas/kountRefundStatus" }, "evaluateKountResult": { "$ref": "#/components/schemas/evaluateKountResult" } }, "required": [ "kountAccountId", "kountApiKey" ] }, "kountInfo": { "description": "Object of Kount response parameters", "type": "object", "properties": { "browser": { "description": "Web Browser", "type": "string", "maxLength": 64, "example": "Google Chrome", "nullable": true }, "cardBrand": { "nullable": true, "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 ], "example": "MASTERCARD" }, "associatedCardCount": { "description": "Total number of credit cards associated to persona as seen by Kount", "type": "integer", "format": "int32", "example": 3, "nullable": true }, "cookiesEnabled": { "description": "A flag to indicate if device placing order has cookies enabled or not", "type": "boolean", "example": true, "nullable": true }, "countersTriggered": { "type": "array", "description": "Counters triggered during rules evaluation", "items": { "$ref": "#/components/schemas/kountTriggeredCounter" } }, "country": { "description": "Two-character ISO country code associated with the physical device", "nullable": true, "type": "string", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" }, "deviceFirstSeenAt": { "description": "Date device first seen", "nullable": true, "type": "string", "format": "date", "example": "2019-07-30" }, "deviceLayers": { "description": "5 device layers that comprise the device's fingerprint, representing OS, browser, Javascript, cookies and Flash settings", "type": "string", "maxLength": 55, "minLength": 55, "nullable": true }, "deviceCount": { "description": "Total number of unique devices associated to persona as seen by Kount", "type": "integer", "format": "int32", "example": 2, "nullable": true }, "deviceScreenResolution": { "description": "Device Screen Resolution", "type": "string", "maxLength": 10, "example": "1920x1080", "nullable": true }, "emailCount": { "description": "Total number of unique email addresses associated to persona as seen by Kount", "type": "integer", "format": "int32", "example": 3, "nullable": true }, "errorCount": { "description": "Number of errors the Kount request generated", "type": "integer", "format": "int32", "example": 3, "nullable": true }, "errorCode": { "description": "Error Code displayed in Risk Inquiry Service response", "type": "string", "maxLength": 4, "example": "1080", "nullable": true }, "kountFingerprint": { "description": "The unique fingerprint of the device placing the order", "type": "string", "maxLength": 32, "example": "123456789h123456789p123456789g12", "nullable": true }, "flashEnabled": { "description": "A flag to indicate if the device placing the order has Flash enabled", "type": "boolean", "example": true, "nullable": true }, "riskiestAssociatedCountry": { "description": "Persona related country with highest probability of fraud\nRefers to Kount's GEOX field.\n", "nullable": true, "type": "string", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" }, "userDefinedHomeCountry": { "description": "User home country the device owner has set in the device's control panel\nRefers to Kount's HTTP_COUNTRY\n", "nullable": true, "type": "string", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" }, "proxyAddress": { "description": "IP address of proxy", "type": "string", "format": "ipv4", "example": "104.75.173.179", "nullable": true }, "javascriptEnabled": { "description": "A flag to indicate if the device placing order has JavaScript enabled", "type": "boolean", "example": true, "nullable": true }, "deviceDataCollectedByDataCollector": { "description": "Flag indicating whether or not device data was collected by the Data Collector process", "type": "boolean", "example": true, "nullable": true }, "knowYourCustomerFlag": { "description": "Know Your Customer Flag", "type": "boolean", "example": true, "nullable": true }, "deviceLanguage": { "description": "The two-character ISO language the device owner has set in the device control panel", "nullable": true, "type": "string", "format": "iso-639", "minLength": 2, "maxLength": 2, "example": "en" }, "localTime": { "description": "The local time the device owner has set in the device control panel", "nullable": true, "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "isMobileDevice": { "description": "Flag to indicate if the device placing the order is a mobile device", "type": "boolean", "example": true, "nullable": true }, "usesMobileForwarder": { "description": "If device is mobile, is it using a forwarder to process the carriers service", "type": "boolean", "example": true, "nullable": true }, "mobileType": { "description": "Type of mobile device, e.g., iPhone, Android, Blackberry, iPad, etc.", "type": "string", "maxLength": 32, "example": "iPhone", "nullable": true }, "kountNetwork": { "description": "Riskiest network type associated with persona within last 14 days:", "type": "string", "nullable": true, "enum": [ "ANONYMOUS", "HIGH_SCHOOL", "LIBRARY", "NORMAL", "OPEN_PROXY", "PRISON", "SATELLITE", null ] }, "mode": { "nullable": true, "description": "Specifies the Risk Inquiry Service post mode type\n\nRisk Inquiry Service Modes\n\nModes are used to specify what type of data is being submitted to Kount.\nNote that ALL FIELD NAMES for a RIS call must be UPPERCASE. They cannot be other case combinations\nsuch as sess, Merc, mOdE. However, the values for fields can be mixed case, such as\nSESS=UpperMixedCaseSessID95628.\n- QUERY = Mode Q\n Initial queries directed from the merchant to Kount that do not originate from a call center\n environment.\n- UPDATE = Mode U\n Update call to Kount, does not cause a reevaluation of the transaction but will update what is displayed\n in the Agent Web Console. This update call does not count towards the number of RIS transactions\n purchased. Only certain fields can be updated with MODE=U calls. The PTYP field can only be updated if\n the initial post to Kount was PTYP=NONE\n", "type": "string", "enum": [ "QUERY", "UPDATE", null ] }, "operatingSystem": { "description": "Operating system of the device", "type": "string", "maxLength": 64, "example": "macOS", "nullable": true }, "pcRemoteEnabled": { "description": "Flag indicating whether the device is enabled to use PC remote software", "type": "boolean", "example": true, "nullable": true }, "proxyEnabled": { "description": "Flag indicating whether or not a proxy server is detected", "type": "boolean", "example": true, "nullable": true }, "piercedAddress": { "$ref": "#/components/schemas/kountPiercedAddress" }, "reasonCode": { "description": "Reason code associated with rule action", "type": "string", "maxLength": 16, "example": "Invalid Data", "nullable": true }, "region": { "description": "Region associated to device location", "type": "string", "maxLength": 2, "example": "CA", "nullable": true }, "riskiestAssociatedRegion": { "description": "Indicates the riskiest geographical location associated with the Persona. \nRefers to Kount's GEOX.\n", "type": "string", "maxLength": 2, "example": "CA", "nullable": true }, "rulesTriggered": { "type": "array", "description": "Rules triggered by post to Kount", "items": { "$ref": "#/components/schemas/kountTriggeredRule" } }, "sessionId": { "nullable": true, "description": "Unique Session ID; must be unique over a 30-day span", "type": "string", "maxLength": 32, "example": "xjudq804i1049jkjakdad" }, "websiteId": { "nullable": true, "description": "Website identifier of where order originated", "type": "string", "maxLength": 8, "example": "DEFAULT" }, "timezone": { "description": "The time zone of the device; In the ISO format of +|–hh:mm", "type": "string", "maxLength": 6, "example": "-04:00", "nullable": true }, "deviceUserAgent": { "nullable": true, "type": "string", "description": "Exact content of the HTTP user-agent header.\nNote, when total length exceeds 2048 characters, truncate the excess portion.\n", "maxLength": 2048, "example": "Mozilla/5.0 (Linux; {Android Version}; {Build Tag etc.})" }, "velocity": { "description": "Quantity of orders seen from persona within last 14 days", "type": "integer", "format": "int64", "example": 8, "nullable": true }, "maximumVelocity": { "description": "Quantity of orders from persona within the most active 6 hour window in last 14 days; payment_response field must be equal to ‘A’", "type": "integer", "format": "int64", "example": 8, "nullable": true }, "kountVersion": { "description": "Specifies version of Kount system being used", "type": "string", "maxLength": 4, "example": "1.0", "nullable": true }, "deviceVoiceActivated": { "description": "If it is a mobile device, flag indicating whether the device is voice activated", "type": "boolean", "example": true, "nullable": true }, "warningCount": { "description": "Number of warnings the Kount Inquiry Service has generated", "type": "integer", "format": "int32", "example": 8, "nullable": true }, "warningCode": { "description": "Warning code displayed in the Risk Inquiry Service response", "type": "string", "maxLength": 4, "example": "180", "nullable": true }, "warningDetail": { "description": "Warning details", "type": "string", "nullable": true } } }, "kountInquiry": { "title": "kountInquiry", "allOf": [ { "type": "object", "properties": { "kountInquiryId": { "$ref": "#/components/schemas/resourceId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "kountResult": { "$ref": "#/components/schemas/kountResult" }, "fraudScore": { "$ref": "#/components/schemas/fraudScore" }, "kountTransactionId": { "$ref": "#/components/schemas/kountTransactionId" } }, "required": [ "kountInquiryId", "kountResult", "kountTransactionId" ] }, { "$ref": "#/components/schemas/kountInfo" } ], "required": [ "orderId", "kountTransactionId", "kountResult" ] }, "kountInquiryList": { "title": "kountInquiryList", "type": "object", "properties": { "data": { "description": "Kount Inquiries list.", "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/kountInquiry" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "kountInquiryRequest": { "title": "kountInquiryRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "kountAccountId": { "$ref": "#/components/schemas/kountAccountId" }, "kountApiKey": { "$ref": "#/components/schemas/kountApiKey" }, "originatedFromCallCenter": { "$ref": "#/components/schemas/originatedFromCallCenter" }, "sessionId": { "$ref": "#/components/schemas/sessionId" }, "websiteId": { "$ref": "#/components/schemas/websiteId" }, "paymentDetails": { "$ref": "#/components/schemas/kountPaymentDetails" }, "email": { "$ref": "#/components/schemas/email" }, "products": { "type": "array", "description": "List of product items part of the transaction", "items": { "$ref": "#/components/schemas/kountProductItem" } }, "automaticNumberId": { "$ref": "#/components/schemas/automaticNumberId" }, "billingAddress": { "nullable": true, "title": "kountBillingAddress", "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" } }, "shippingAddress": { "nullable": true, "title": "kountShippingAddress", "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" } }, "dateOfBirth": { "description": "Date of Birth.", "nullable": true, "type": "string", "format": "date", "example": "2019-07-30" }, "timestamp": { "description": "This is timestamp associated with the creation of a user in Kount service.", "nullable": true, "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "gender": { "$ref": "#/components/schemas/gender" }, "customerName": { "$ref": "#/components/schemas/fullName" }, "financialOrderId": { "$ref": "#/components/schemas/financialOrderId" }, "shippingType": { "$ref": "#/components/schemas/shippingType" }, "ipv4": { "nullable": false, "type": "string", "format": "ipv4", "description": "Internet Protocol version 4 (IPv4).", "example": "104.75.173.179" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey", "kountAccountId", "kountApiKey", "paymentDetails", "originatedFromCallCenter", "sessionId", "websiteId", "ipv4", "email", "products" ] }, "kountPaymentData": { "title": "Kount Payment Data", "description": "Payment Data", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "lastFour": { "nullable": true, "type": "string", "description": "Last 4 digits of the card.", "minLength": 4, "maxLength": 4, "example": "1234" }, "paymentToken": { "$ref": "#/components/schemas/paymentToken" }, "paymentType": { "$ref": "#/components/schemas/paymentType" } }, "required": [ "paymentToken", "paymentType", "amount" ] }, "kountPaymentDetails": { "title": "kountPaymentDetails", "description": "Payment Data", "oneOf": [ { "$ref": "#/components/schemas/kountPaymentId" }, { "$ref": "#/components/schemas/kountValidationId" }, { "$ref": "#/components/schemas/kountPaymentData" } ] }, "kountPaymentId": { "title": "Kount Payment Id", "type": "object", "description": "Payment Id", "properties": { "paymentId": { "$ref": "#/components/schemas/paymentId" } }, "required": [ "paymentId" ] }, "kountPiercedAddress": { "type": "object", "description": "Pierced IP Address details.", "nullable": true, "properties": { "latitude": { "description": "Latitude of pierced IP address", "type": "number", "format": "double", "example": -90.1922, "nullable": true }, "longitude": { "description": "Longitude of pierced IP address", "type": "number", "format": "double", "example": 38.6312, "nullable": true }, "city": { "nullable": true, "type": "string", "description": "Identifies the city.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "region": { "description": "State/Region of pierced IP address", "type": "string", "example": "Ontario", "maxLength": 255, "nullable": true }, "owner": { "description": "Owner of pierced IP address or address block", "type": "string", "maxLength": 64, "nullable": true }, "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" } } }, "kountProductItem": { "type": "object", "description": "Item part of the transaction", "properties": { "itemId": { "$ref": "#/components/schemas/itemId" }, "itemType": { "$ref": "#/components/schemas/itemType" }, "itemQuantity": { "type": "integer", "format": "int32", "description": "Quantity invoiced for this line item.", "minimum": 0, "maximum": 999999999, "example": 82, "nullable": true }, "itemName": { "nullable": true, "type": "string", "description": "Item Name", "minLength": 1, "maxLength": 50, "example": "Canned Food" }, "itemAmount": { "title": "kountProductItemamount", "nullable": true, "type": "object", "description": "Contains the individual item amount that is normally calculated as price multiplied by quantity. The value must be in cents. Therefore $10.59 must be sent as 1059", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 15000, "currency": "CAD" } } }, "required": [ "itemId", "itemType" ] }, "kountRefundStatus": { "description": "Refund/Chargeback status. R - Refund, C - Chargeback", "type": "string", "nullable": true, "enum": [ "REFUND", "CHARGEBACK", null ] }, "kountResult": { "description": "Auto-decision response", "type": "string", "enum": [ "APPROVED", "DECLINED", "UNDER_REVIEW" ] }, "kountTransactionId": { "description": "Kount Transaction ID", "type": "string", "maxLength": 12, "example": "123456789012" }, "kountTriggeredCounter": { "type": "object", "description": "Kount Counter that was triggered", "properties": { "name": { "type": "string", "description": "Counter Name", "maxLength": 64 }, "value": { "type": "number", "format": "double", "description": "The sum of the number of times a counter was triggered.", "nullable": true } }, "required": [ "name" ] }, "kountTriggeredRule": { "type": "object", "description": "Kount rule that was triggered", "properties": { "id": { "description": "Rule ID associated with merchant-created rules", "type": "integer", "format": "int64", "example": 8 }, "description": { "description": "Rule descriptions associated with the Id", "type": "string", "maxLength": 255, "nullable": true, "example": "Rule description example" } } }, "kountValidationId": { "title": "Kount Validation Id", "type": "object", "description": "Validation Id", "properties": { "validationId": { "$ref": "#/components/schemas/resourceId" }, "amount": { "$ref": "#/components/schemas/money" } }, "required": [ "validationId", "amount" ] }, "language": { "type": "string", "format": "iso-639", "description": "Provides the two letter language code according the ISO 639-1 standard. \n\nFor a complete list of language codes, visit: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.\n", "minLength": 2, "maxLength": 2, "example": "en" }, "last": { "description": "Pagination link pointing to the last page.", "type": "string", "format": "uri-reference", "nullable": true }, "lastInstallment": { "type": "object", "description": "Cost details (fee and principal) for the last Installment.", "properties": { "installmentFee": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "installmentAmount": { "$ref": "#/components/schemas/money" } }, "required": [ "installmentAmount" ] }, "lastName": { "type": "string", "description": "Last name.", "minLength": 1, "maxLength": 30, "example": "Doe", "nullable": true }, "legalEntity": { "type": "object", "title": "Legal Entity", "description": "An object containing all details about the legal entity of the business.", "required": [ "businessType" ], "properties": { "businessType": { "$ref": "#/components/schemas/businessType" } } }, "legalName": { "type": "string", "description": "The registered name of the merchant.", "maxLength": 60, "example": "Pizza 2 Go" }, "lookupRequest": { "title": "challengeFlowRequest", "description": "The point of the 3-D Secure flow is to verify that the true cardholder is a part of the authorization. The challenge flow is used to present a way of authenticating the cardholder using e.g. OTP or a federated identification method.", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "threeDSecureChallengeResponseData": { "$ref": "#/components/schemas/threeDSecureChallengeResponseData" } }, "required": [ "idempotencyKey", "threeDSecureChallengeResponseData" ] }, "manufacturer": { "type": "string", "description": "The name of the company that produces the terminal.", "nullable": true, "maxLength": 50 }, "marketSegment": { "type": "string", "description": "Identifies the specific customer or business segment targeted by a product or service.", "nullable": true, "enum": [ "PAYROC", "ADVANCE_IT", "ATB", "ATB_8760", "ADYEN", "BRAINTREE", "CYDCOR", "DIRECT_CASH", "INTUIT", "MCA", "OPTIMAL", "PAYSAFE_RETAIL_RESELLER", "PROTOCOL", "SAGE", "SONA", "SOFT_TECH", "TILL_PAYMENTS", "UEAT", "CLEVERPAYS", "PAYLITE", "ILIXIUM", "LOYALTY_SENSE", "POWER_PAYMENTS", "PAYMENT_EXPERTS", "INTERNATIONAL_PAYMENT_SOLUTIONS", "PAYOLOGY", "NATIONAL_PAYMENTS" ] }, "masterCardDebitTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through MasterCard Debit payments.", "format": "int32", "example": 1000 }, "masterCardTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through MasterCard payments.", "format": "int32" }, "maximumDisqualifiedTransactionMerchantDiscountRate": { "type": "number", "description": "The maximum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "maximumMerchantDiscountRate": { "type": "number", "description": "The maximum merchant discount rate that applies under the transaction plan.", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "maximumTransactionVolume": { "type": "integer", "description": "A numeric value that represents the highest expected transaction volume.", "format": "int32" }, "merchant": { "description": "An object containing the details of a merchant.", "type": "object", "properties": { "merchantId": { "$ref": "#/components/schemas/merchantId" }, "businessDetails": { "nullable": true, "type": "object", "description": "An object containing key information about the business associated with the account or transaction.", "required": [ "merchantCategoryCode", "isSeasonalMerchant", "directSellingPercentage", "motoTransactionPercentage", "ecommerceTransactionPercentage" ], "properties": { "merchantCategoryCode": { "$ref": "#/components/schemas/merchantCategoryCode" }, "averageTicketSize": { "$ref": "#/components/schemas/averageTicketSize" }, "isSeasonalMerchant": { "$ref": "#/components/schemas/isSeasonalMerchant" }, "maximumTransactionVolume": { "$ref": "#/components/schemas/maximumTransactionVolume" }, "directSellingPercentage": { "$ref": "#/components/schemas/directSellingPercentage" }, "motoTransactionPercentage": { "$ref": "#/components/schemas/motoTransactionPercentage" }, "ecommerceTransactionPercentage": { "$ref": "#/components/schemas/ecommerceTransactionPercentage" }, "businessUrl": { "$ref": "#/components/schemas/businessUrl" }, "serviceProvider": { "$ref": "#/components/schemas/serviceProvider" }, "serviceDeliverToCanadaAvailable": { "$ref": "#/components/schemas/serviceDeliverToCanadaAvailable" }, "serviceDeliverToUSAvailable": { "$ref": "#/components/schemas/serviceDeliverToUSAvailable" }, "creditTransactionVolume": { "$ref": "#/components/schemas/creditTransactionVolume" }, "masterCardTransactionVolume": { "$ref": "#/components/schemas/masterCardTransactionVolume" }, "visaTransactionVolume": { "$ref": "#/components/schemas/visaTransactionVolume" }, "visaDebitTransactionVolume": { "$ref": "#/components/schemas/visaDebitTransactionVolume" }, "amexTransactionVolume": { "$ref": "#/components/schemas/amexTransactionVolume" }, "interacTransactionVolume": { "$ref": "#/components/schemas/interacTransactionVolume" }, "masterCardDebitTransactionVolume": { "$ref": "#/components/schemas/masterCardDebitTransactionVolume" }, "unionPayTransactionVolume": { "$ref": "#/components/schemas/unionPayTransactionVolume" }, "discoverTransactionVolume": { "$ref": "#/components/schemas/discoverTransactionVolume" }, "category": { "$ref": "#/components/schemas/businessCategory" }, "subCategory": { "$ref": "#/components/schemas/businessSubCategory" }, "offeredProductsAndServicesDescription": { "$ref": "#/components/schemas/offeredProductsAndServicesDescription" }, "riskLevel": { "$ref": "#/components/schemas/riskLevel" } } }, "merchantDetails": { "nullable": true, "type": "object", "description": "An object that contains key information about the merchant associated.", "required": [ "contactInformation", "merchantInformation", "locationAddress" ], "properties": { "contactInformation": { "$ref": "#/components/schemas/contactInformation" }, "merchantInformation": { "$ref": "#/components/schemas/merchantInformation" }, "locationAddress": { "$ref": "#/components/schemas/address" }, "marketSegment": { "$ref": "#/components/schemas/marketSegment" } } }, "businessActivity": { "nullable": true, "type": "object", "description": "An object containing all details about the business activity.", "required": [ "dropShipping" ], "properties": { "dropShipping": { "$ref": "#/components/schemas/dropShipping" } } }, "securityDetails": { "nullable": true, "type": "object", "description": "An object containing all details about the security details.", "required": [ "legalEntity", "signingOfficers" ], "properties": { "legalEntity": { "$ref": "#/components/schemas/legalEntity" }, "signingOfficers": { "type": "array", "description": "A list of signing officer entities.", "maxItems": 100, "items": { "$ref": "#/components/schemas/signingOfficer" } } } }, "riskDetails": { "nullable": true, "type": "object", "description": "An object containing information related to the risk assessment of a transaction or account.", "required": [ "merchantRiskRate" ], "properties": { "merchantRiskRate": { "$ref": "#/components/schemas/merchantRiskRate" } } }, "pointOfSaleOptions": { "nullable": true, "type": "object", "description": "An object containing details about the point of sale options available for processing transactions.", "required": [ "settlementOption" ], "properties": { "settlementOption": { "$ref": "#/components/schemas/settlementOption" }, "settlementTime": { "$ref": "#/components/schemas/settlementTime" }, "debitPerTransactionRefundLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "dailyRefundLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "dailyCancellationLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "bankingDetails": { "nullable": true, "type": "object", "description": "An object that contains the necessary banking information related to the account or transaction.", "required": [ "creditDepositAccount" ], "properties": { "creditDepositAccount": { "$ref": "#/components/schemas/bank" }, "additionalBankingAccounts": { "type": "array", "description": "A list of additional banking accounts associated with the merchant.", "items": { "$ref": "#/components/schemas/additionalBankingAccount" }, "maxItems": 10 } } }, "chainId": { "$ref": "#/components/schemas/chainId" }, "createdAt": { "nullable": true, "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" } }, "required": [ "merchantId" ] }, "merchantCategoryCode": { "type": "string", "description": "A four-digit code that classifies the type of business or service provided by the merchant, based on standard industry categories.", "minLength": 4, "maxLength": 4, "example": "0742" }, "merchantDetails": { "type": "object", "description": "An object that contains key information about the merchant associated.", "required": [ "contactInformation", "merchantInformation", "locationAddress" ], "properties": { "contactInformation": { "$ref": "#/components/schemas/contactInformation" }, "merchantInformation": { "$ref": "#/components/schemas/merchantInformation" }, "locationAddress": { "$ref": "#/components/schemas/address" }, "marketSegment": { "$ref": "#/components/schemas/marketSegment" } } }, "merchantDiscountRate": { "type": "number", "description": "The merchant discount rate applied to transactions under transaction plan.", "format": "double", "default": 0, "minimum": 0, "maximum": 1 }, "merchantDiscountRateType": { "type": "string", "description": "The type of Merchant Discount Rate applied to a card plan.", "nullable": true, "enum": [ "NET", "GROSS", "GROSS_GROSS" ] }, "merchantId": { "type": "string", "description": "Thirteen character long identification provided to merchants by Moneris. \n", "minLength": 13, "maxLength": 13, "example": "0123456789101" }, "merchantInformation": { "type": "object", "description": "An object containing all information about the merchant.", "required": [ "language", "legalName", "operatingAsName", "cardholderName", "yearsOfOwnership", "monthsOfOwnership", "customerServicePhoneNumber", "email" ], "properties": { "language": { "enum": [ "en", "fr" ], "description": "The preferred language of the merchant.", "type": "string", "format": "iso-639", "minLength": 2, "maxLength": 2, "example": "en" }, "legalName": { "$ref": "#/components/schemas/legalName" }, "operatingAsName": { "$ref": "#/components/schemas/operatingAsName" }, "cardholderName": { "description": "The name of the person to whom the credit or debit card is issued.", "nullable": true, "type": "string", "minLength": 1, "maxLength": 60, "example": "John Doe" }, "yearsOfOwnership": { "$ref": "#/components/schemas/yearsOfOwnership" }, "monthsOfOwnership": { "$ref": "#/components/schemas/monthsOfOwnership" }, "customerServicePhoneNumber": { "$ref": "#/components/schemas/phoneNumber" }, "email": { "$ref": "#/components/schemas/email" }, "merchantType": { "$ref": "#/components/schemas/merchantType" } } }, "merchantNumber": { "type": "string", "description": "Identifies the merchant within he acquirer's system.", "nullable": true, "maxLength": 10 }, "merchantOrderId": { "type": "integer", "description": "A unique identifier assigned by the merchant to track a specific customer order.", "format": "int64", "example": 2341123 }, "merchantPayload": { "type": "object", "description": "An object containing the merchant payload details.", "required": [ "bankingDetails", "businessDetails", "merchantDetails", "businessActivity", "securityDetails" ], "properties": { "chainId": { "$ref": "#/components/schemas/chainId" }, "bankingDetails": { "$ref": "#/components/schemas/bankingDetails" }, "pointOfSaleOptions": { "nullable": true, "type": "object", "description": "An object containing details about the point of sale options available for processing transactions.", "required": [ "settlementOption" ], "properties": { "settlementOption": { "$ref": "#/components/schemas/settlementOption" }, "settlementTime": { "$ref": "#/components/schemas/settlementTime" }, "debitPerTransactionRefundLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "dailyRefundLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "dailyCancellationLimit": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "businessDetails": { "$ref": "#/components/schemas/businessDetails" }, "merchantDetails": { "$ref": "#/components/schemas/merchantDetails" }, "businessActivity": { "$ref": "#/components/schemas/businessActivity" }, "securityDetails": { "$ref": "#/components/schemas/securityDetails" }, "riskDetails": { "nullable": true, "type": "object", "description": "An object containing information related to the risk assessment of a transaction or account.", "required": [ "merchantRiskRate" ], "properties": { "merchantRiskRate": { "$ref": "#/components/schemas/merchantRiskRate" } } } } }, "merchantRiskRate": { "type": "string", "description": "A score indicating the level of risk associated with the merchant's transactions.", "maxLength": 60, "example": "A+", "enum": [ "A", "A_PLUS", "B_HIGH", "B_LOW", "B_LOW_PLUS", "B_MID", "C", "C_HIGH", "C_HIGH_PLUS", "C_LOW", "C_LOW_PLUS", "C_MID", "C_MID_PLUS", "C_PLUS", "D", "D_HIGH", "D_LOW", "D_MID", "E", "E_MINUS", "F" ] }, "merchantSupplies": { "description": "An object containing a list of supplies associated with the merchant.", "type": "object", "properties": { "data": { "type": "array", "description": "A list of supply items associated with the resource", "items": { "$ref": "#/components/schemas/merchantSupply" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } } }, "merchantSupply": { "type": "object", "description": "An object containing all details related to a merchant supply.", "required": [ "deviceName", "supplyType" ], "properties": { "deviceName": { "$ref": "#/components/schemas/deviceName" }, "carriers": { "$ref": "#/components/schemas/carriers" }, "softwareVendors": { "$ref": "#/components/schemas/softwareVendors" }, "cardReaderName": { "$ref": "#/components/schemas/cardReaderName" }, "pinpadType": { "$ref": "#/components/schemas/pinpadType" }, "serviceCode": { "$ref": "#/components/schemas/serviceCode" }, "unitPrice": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "supplyType": { "$ref": "#/components/schemas/supplyType" }, "supplies": { "type": "array", "description": "A list of supplies associated with the device.", "items": { "$ref": "#/components/schemas/supply" } } } }, "merchantType": { "type": "string", "description": "The category of the merchant's business.", "nullable": true, "enum": [ "NATIONAL", "INDEPENDENT_BUSINESS" ] }, "message": { "type": "string", "description": "Displays response description returned from issuing institution.\n\n**NOTE**: This message should not be displayed on any cardholder facing materials. \n\nFor receipt purposes, please refer to the Receipt Requirements\"\n", "minLength": 1, "maxLength": 100, "example": "SUCCESS", "nullable": true }, "middleName": { "type": "string", "description": "Customer's middle name.", "minLength": 1, "maxLength": 30, "example": "J.", "nullable": true }, "minimumDisqualifiedTransactionMerchantDiscountRate": { "type": "number", "description": "The minimum merchant discount rate value applied to transactions that do not meet certain qualifying criteria under the transaction plan.", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "minimumMerchantDiscountRate": { "type": "number", "description": "The minimum merchant discount rate that applies under the transaction plan.", "format": "double", "default": 0, "minimum": 0, "maximum": 1 }, "modifiedAt": { "nullable": true, "description": "Time at which the object was modified", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "monerisAdvance": { "type": "object", "description": "An object containing details related to Moneris Advance.", "nullable": true, "properties": { "approvedAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "collectionRate": { "$ref": "#/components/schemas/collectionRate" }, "premiumAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "isEligible": { "type": "boolean", "description": "A boolean flag indicating whether the product is eligible for a specific service or feature." }, "feeDetails": { "$ref": "#/components/schemas/monerisAdvanceFeeDetails" } } }, "monerisAdvanceFeeDetails": { "type": "object", "description": "A list of fees associated with Moneris Advance.", "nullable": true, "properties": { "preferredAmountFee": { "description": "The preferred amount charged for the Moneris Advance service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "chargeableAmountFee": { "description": "The amount that is charged for the Moneris Advance service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "monerisGateway": { "type": "object", "description": "An object containing details about the Moneris Gateway product.", "nullable": true, "properties": { "isPaymentRequestForMonerisGateway": { "type": "boolean", "description": "A boolean flag indicating whether the payment request is specifically for the Moneris Gateway product." }, "isEcommerce": { "type": "boolean", "description": "A boolean flag indicating whether the product is intended for online environments." }, "cardNotPresentConfigurationCode": { "$ref": "#/components/schemas/cardNotPresentConfigurationCode" }, "feeDetails": { "$ref": "#/components/schemas/monerisGatewayFeeDetails" } } }, "monerisGatewayFeeDetails": { "type": "object", "description": "A list of fees associated to Moneris Gateway.", "nullable": true, "properties": { "baseFee": { "description": "The standard fee charged for a product.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "recurringFee": { "description": "A fee that is charged on a regular basis.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "batchProcessingFee": { "description": "Indicates whether fees apply to batch processing services.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "cardPresentDebitFee": { "description": "Represents the fee applied to debit card transactions.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "levelTwoThreeFee": { "description": "A fee associated with level 2 or level 3 processing.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "setupFee": { "description": "A one-time fee charged for the initial configuration and onboarding of the product.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultFee": { "description": "A fee charged for using a secure card vault service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "riskToolFee": { "description": "A fee associated with the use of fraud prevention and risk managements tools.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "addressVerificationServiceFee": { "description": "A fee charged for using the address verification service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "verifiedByVisaFee": { "description": "A fee associated with verified by visa.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultOneTimeFee": { "description": "A one-time fee charged for the initial setup or activation or a card vault service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultPerTransactionFee": { "description": "A fee charged for each transaction that utilizes the stored payment credentials.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "vaultPerClickPerTransactionFee": { "description": "A fee charged for each transaction processed using a tokenized payment method from the vault, initiated by a single click or action.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "interacRegistrationFee": { "description": "A fee associated with registering a merchant or account for Interac services.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "interacFlatFee": { "description": "A flat fee applied to each transaction processed through the Interac network.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "interacRateFee": { "description": "A percentage-based fee applied to transactions processed through the Interac network.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "transactionFee": { "description": "A fee applied per individual transaction processed.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "monthlyFee": { "description": "A recurring fee charged on a monthly basis for continued access.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "boostMonthlyFee": { "description": "An additional recurring fee charged on a monthly basis for enhanced services or features.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "netSuiteMonthlyFee": { "description": "A recurring montly fee for the integration or use of the NetSuite platform.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "tokenSharingSetupFee": { "description": "A one-time fee charged for setting up token sharing services.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "eCommerceAssessmentTransactionFee": { "description": "A fee applied to transaction assessed for e-commerce risk.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "eCommerceCardBrandTransactionFee": { "description": "A fee applied to e-commerce transactions based on the card brand.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "eCommerceMerchantDiscountRateFee": { "description": "The Merchant Discount Rate for e-commerce transactions.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "eCommerceTransactionFee": { "description": "A fee applied to each e-commerce transaction processed.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "kountFee": { "description": "A fee associated with the use of Kount tool.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "kountOneTimeFee": { "description": "A one-time fee charged for the initial setup or activation of Kount.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "kountPerTransactionFee": { "description": "A fee applied to each transaction processed using Kount.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visa3dSecureAuthenticationTransactionFee": { "description": "A fee applied to transaction processed using Visa's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "amex3dSecureAuthenticationTransactionFee": { "description": "A fee applied to transaction processed using Amex's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "mastercard3dSecureAuthenticationTransactionFee": { "description": "A fee applied to transaction processed using Mastercard's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visa3dSecureAuthenticationMerchantDiscountRateFee": { "description": "The Merchant Discount Rate applied to transactions processed through Visa's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "amex3dSecureAuthenticationMerchantDiscountRateFee": { "description": "The Merchant Discount Rate applied to transactions processed through Amex's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "mastercard3dSecureAuthenticationMerchantDiscountRateFee": { "description": "The Merchant Discount Rate applied to transactions processed through Mastercard's 3D secure authentication protocol.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "monerisGoAppetit": { "type": "object", "description": "An object containing details about the Moneris Go Appetit product.", "nullable": true, "properties": { "softwarePackageName": { "type": "string", "description": "The name of the software package associated with the Moneris Go Appetit product.", "maxLength": 100, "nullable": true }, "referringSalesRepresentativeCode": { "type": "string", "nullable": true, "description": "The code of the sales representative referring the Moneris Go Appetit product.", "maxLength": 50 }, "hasDevice": { "type": "boolean", "description": "A boolean flag indicating whether the Moneris Go Appetit product includes a device." }, "timeZoneName": { "type": "string", "description": "The time zone associated with the Moneris Go Appetit product.", "maxLength": 50, "nullable": true }, "feeDetails": { "type": "object", "nullable": true, "description": "An object representing the fees associated with the Moneris Go Appetit product.", "properties": { "softwarePackageFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "tabletLicenseFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "reservationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "onlineOrderingFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } } } }, "monerisGoPointOfSaleRetail": { "type": "object", "description": "An object containing the Moneris Go point of sale retail details.", "nullable": true, "properties": { "feeDetails": { "$ref": "#/components/schemas/monerisGoPointOfSaleRetailFeeDetails" } } }, "monerisGoPointOfSaleRetailFeeDetails": { "type": "object", "description": "A list of fees associated with Moneris Go POS Retail.", "nullable": true, "properties": { "goRetailFee": { "description": "A fee associated with retail operations.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "monerisGoPortal": { "type": "object", "description": "An object containing the Moneris Go Portal details.", "nullable": true, "properties": { "pricingModel": { "$ref": "#/components/schemas/pricingModel" }, "feeDetails": { "$ref": "#/components/schemas/monerisGoPortalFeeDetails" } } }, "monerisGoPortalFeeDetails": { "type": "object", "description": "A list of fees associated with Moneris Go Portal.", "nullable": true, "properties": { "setupFee": { "description": "A one-time fee charged for the initial configuration and onboarding of the product.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "accessFee": { "description": "A fee charged for gaining access to the service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "money": { "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "monthsOfOwnership": { "type": "integer", "description": "An integer representing the number of months the merchant has been in ownership.", "format": "int32" }, "motoTransactionPercentage": { "description": "The percentage of transactions processed through mail order / telephone order.", "type": "number", "format": "decimal", "minimum": 0, "maximum": 100, "example": 90.5 }, "multiCurrencyPricingDetails": { "type": "object", "nullable": true, "description": "Exchange rate for use in a subsequent MCP financial transaction", "properties": { "cardholderAmount": { "$ref": "#/components/schemas/money" }, "merchantSettlementAmount": { "description": "The amount that will be paid to the merchant, in settlement currency", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "multiCurrencyPricingExchangeRate": { "description": "The foreign exchange rate (foreign currency to CAD) that will be used for the transaction", "type": "number", "format": "decimal", "example": 1.2346 } }, "required": [ "cardholderAmount", "merchantSettlementAmount", "multiCurrencyPricingExchangeRate" ], "example": { "cardholderAmount": { "currency": "USD", "amount": 30000 }, "multiCurrencyPricingRate": 1.2345 } }, "multiCurrencyPricingOptIn": { "type": "string", "description": "Indicates if Multi-Currency Pricing is to be used for this transaction.", "enum": [ "OPT_IN" ], "example": "OPT_IN" }, "multiCurrencyPricingRateCardholderInformation": { "type": "object", "description": "Multi-Currency Pricing (MCP) Rate Information Object", "properties": { "amountType": { "type": "string", "description": "The type of rate lookup to perform.", "enum": [ "CARDHOLDER" ], "example": "CARDHOLDER" }, "amount": { "$ref": "#/components/schemas/money" } }, "required": [ "amount", "amountType" ] }, "multiCurrencyPricingRateConversion": { "type": "object", "description": "Exchange rate for use in a subsequent MCP financial transaction", "properties": { "cardholderAmount": { "$ref": "#/components/schemas/money" }, "merchantSettlementAmount": { "description": "The amount that will be paid to the merchant, in settlement currency", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "multiCurrencyPricingExchangeRate": { "description": "The foreign exchange rate (foreign currency to CAD) that will be used for the transaction", "type": "number", "format": "decimal", "example": 1.2346 }, "multiCurrencyPricingStatusCode": { "description": "HTTP Status code of the MCP transaction", "type": "integer", "format": "int32", "minimum": 100, "maximum": 9999, "example": 200 }, "multiCurrencyPricingStatusMessage": { "description": "Message corresponding to the MCP Status Code", "type": "string" } }, "required": [ "cardholderAmount", "merchantSettlementAmount", "multiCurrencyPricingExchangeRate", "multiCurrencyPricingStatusCode", "multiCurrencyPricingStatusMessage" ], "example": { "cardholderAmount": { "currency": "USD", "amount": 30000 }, "merchantSettlementAmount": { "currency": "CAD", "amount": 25000 }, "multiCurrencyPricingRate": 1.2345, "multiCurrencyPricingStatusCode": 200, "multiCurrencyPricingStatusMessage": "OK" } }, "multiCurrencyPricingRateInformationRequest": { "description": "Multi-Currency Pricing (MCP) Rate Information Request Object", "oneOf": [ { "$ref": "#/components/schemas/multiCurrencyPricingRateCardholderInformation" }, { "$ref": "#/components/schemas/multiCurrencyPricingRateMerchantSettlementInformation" } ], "discriminator": { "propertyName": "amountType", "mapping": { "CARDHOLDER": "#/components/schemas/multiCurrencyPricingRateCardholderInformation", "MERCHANT_SETTLEMENT": "#/components/schemas/multiCurrencyPricingRateMerchantSettlementInformation" } } }, "multiCurrencyPricingRateLookup": { "title": "Multi-Currency Pricing (MCP) Rate Response", "type": "object", "properties": { "multiCurrencyPricingRateLookupId": { "$ref": "#/components/schemas/resourceId" }, "multiCurrencyPricingTransactionType": { "$ref": "#/components/schemas/multiCurrencyPricingTransactionType" }, "rateValidityEndTime": { "$ref": "#/components/schemas/dateTime" }, "rateConversions": { "type": "array", "items": { "$ref": "#/components/schemas/multiCurrencyPricingRateConversion" }, "example": [ { "cardholderAmount": { "amount": 3000, "currency": "USD" }, "merchantSettlementAmount": { "amount": 4024, "currency": "CAD" }, "multiCurrencyPricingExchangeRate": 1.3413, "multiCurrencyPricingStatusCode": 200, "multiCurrencyPricingStatusMessage": "" }, { "cardholderAmount": { "amount": 2993, "currency": "USD" }, "merchantSettlementAmount": { "amount": 4015, "currency": "CAD" }, "multiCurrencyPricingExchangeRate": 1.3413, "multiCurrencyPricingStatusCode": 200, "multiCurrencyPricingStatusMessage": "" } ] }, "customData": { "nullable": true, "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 }, "createdAt": { "$ref": "#/components/schemas/createdAt" } }, "required": [ "multiCurrencyPricingRateLookupId", "multiCurrencyPricingTransactionType", "rateValidityEndTime", "rateConversions", "createdAt" ] }, "multiCurrencyPricingRateLookupRequest": { "title": "Multi-Currency Pricing (MCP) Rate Request", "type": "object", "properties": { "multiCurrencyPricingTransactionType": { "$ref": "#/components/schemas/multiCurrencyPricingTransactionType" }, "multiCurrencyPricingRateInformationRequests": { "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/multiCurrencyPricingRateInformationRequest" }, "example": [ { "amount": { "currency": "USD", "amount": 3000 }, "amountType": "CARDHOLDER" }, { "amount": { "currency": "USD", "amount": 4015 }, "cardholderCurrency": "USD", "amountType": "MERCHANT_SETTLEMENT" } ] }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "multiCurrencyPricingTransactionType", "multiCurrencyPricingRateInformationRequests" ] }, "multiCurrencyPricingRateMerchantSettlementInformation": { "type": "object", "description": "Multi-Currency Pricing (MCP) Rate Merchant Settlement Information Object", "properties": { "amountType": { "type": "string", "description": "The type of rate lookup to perform.", "enum": [ "MERCHANT_SETTLEMENT" ], "example": "MERCHANT_SETTLEMENT" }, "amount": { "$ref": "#/components/schemas/money" }, "cardholderCurrency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "amountType", "cardholderCurrency" ] }, "multiCurrencyPricingTransactionRequest": { "description": "Multi-Currency Pricing (MCP) Object", "title": "multiCurrencyPricingDetails", "type": "object", "nullable": true, "properties": { "multiCurrencyPricingOptIn": { "$ref": "#/components/schemas/multiCurrencyPricingOptIn" }, "multiCurrencyPricingRateLookupId": { "nullable": true, "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" } }, "required": [ "multiCurrencyPricingOptIn" ] }, "multiCurrencyPricingTransactionType": { "type": "string", "description": "Value representing the type of subsequent transaction request that the rate token will be used for", "enum": [ "PAYMENT", "REFUND" ], "example": "PAYMENT" }, "multiCurrencyProduct": { "type": "object", "description": "An object containing details about the multi currency product.", "nullable": true, "properties": { "feeDetails": { "type": "object", "description": "An object representing the fees associated with the multi-currency product.", "nullable": true, "properties": { "setupFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "nonDomesticSettlementFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaBusinessToBusinessVirtualForeignFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaBusinessToBusinessVirtualForeignSingleCurrencyFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaBusinessToBusinessAssessmentForeignSingleCurrencyFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaBusinessToBusinessAssessmentForeignFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaAssessmentSingleCurrencyFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "visaAssessmentForeignFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "packageIdentifier": { "type": "string", "description": "A unique identifier for the multi-currency pricing package.", "maxLength": 50, "nullable": true }, "packageDescription": { "type": "string", "description": "A description of the multi-currency pricing package.", "maxLength": 100, "nullable": true }, "markUpPercentage": { "type": "number", "description": "The mark up percentage charged for multi currency transactions.", "format": "float", "minimum": 0, "maximum": 100 }, "revenueSharePercentage": { "type": "number", "description": "The percentage of revenue shared with the merchant.", "format": "float", "minimum": 0, "maximum": 100 } } }, "multipleCompletion": { "description": "Multiple Completion object containing amount, processedAt time, and finalCompletion flag", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" }, "finalCompletion": { "type": "boolean", "description": "Indicates whether this is the last Completion request for a Payment. To indicate that additional Completions will be performed, please pass finalCompletion as false." } }, "required": [ "amount", "processedAt", "finalCompletion" ] }, "multipleCompletions": { "description": "List of all Multiple Completion transactions.", "type": "array", "items": { "$ref": "#/components/schemas/multipleCompletion" } }, "next": { "description": "Pagination link pointing to the next page.", "type": "string", "format": "uri-reference", "nullable": true }, "offeredProductsAndServicesDescription": { "type": "string", "description": "A description of type of products and services offered by the business.", "nullable": true, "maxLength": 255, "example": "food" }, "ofiCardPlan": { "type": "object", "description": "An object containing all details about the Ofi Card Plan.", "properties": { "otherFinancialInstitutionCardType": { "$ref": "#/components/schemas/otherFinancialInstitutionCardType" }, "cardAcquirer": { "$ref": "#/components/schemas/cardAcquirer" }, "merchantNumber": { "$ref": "#/components/schemas/merchantNumber" }, "region": { "$ref": "#/components/schemas/region" }, "transitNumber": { "$ref": "#/components/schemas/transitNumber" }, "accountNumber": { "$ref": "#/components/schemas/accountNumber" }, "transactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "depositType": { "$ref": "#/components/schemas/depositType" }, "authorizationDescription": { "$ref": "#/components/schemas/authorizationDescription" }, "cardOption": { "$ref": "#/components/schemas/cardOption" } } }, "operatingAsName": { "type": "string", "description": "The trade name under which the merchant operates.", "maxLength": 30, "example": "Pizza 2 Go" }, "order": { "type": "object", "description": "An object containing all the details related to the order details response.", "required": [ "merchantOrderId", "merchantId" ], "properties": { "merchantOrderId": { "$ref": "#/components/schemas/merchantOrderId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "userIdentifier": { "type": "string", "description": "Identifies the user associated with the order.", "nullable": true }, "representativeCode": { "type": "string", "description": "Represents the identifies for the sales representative associated to the order.", "nullable": true }, "adjudicationRequired": { "type": "boolean", "description": "A boolean flag that indicates whether the order requires an adjudication process." }, "orderStatus": { "$ref": "#/components/schemas/orderStatus" }, "orderType": { "type": "string", "description": "The classification or category of the order.", "nullable": true, "enum": [ "CHIP", "EXISTING_MERCHANT", "EXISTING_MERCHANT_ADD_POS", "EXISTING_MERCHANT_NEW_POS", "EXISTING_MERCHANT_UPGRADE_POS", "EXISTING_POS", "M9000", "MERCHANT_UPDATE", "NET_NEW_MERCHANT", "PRICING_UPDATE", "READJUDICATION", "SC220", "SC220CAN" ] }, "orderOpenedAt": { "type": "string", "description": "A datetime attribute that records the exact date and time when the order was initiated in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-03-21T18:10:00Z" }, "orderChangedAt": { "type": "string", "description": "A datetime attribute that records the exact date and time when the order was modified in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-03-21T18:10:00Z" }, "orderApprovedAt": { "type": "string", "description": "A datetime attribute that records the exact date and time when the order was approved in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-03-21T18:10:00Z" }, "orderDeclinedAt": { "type": "string", "description": "A datetime attribute that records the exact date and time when the order was declined in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-03-21T18:10:00Z" }, "orderClosedAt": { "type": "string", "description": "A datetime attribute that records the exact date and time when the order was closed in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-03-21T18:10:00Z" }, "contractSent": { "type": "boolean", "description": "A boolean flag indicating whether the date the contract was sent." }, "feeDetails": { "$ref": "#/components/schemas/feeDetails" }, "promotionInformation": { "type": "object", "description": "An object containing information related to the promotion associated with the order.", "nullable": true, "properties": { "promotionCode": { "type": "string", "description": "A string attribute used to store a promotional or discount code that maybe applied to the order.", "nullable": true }, "promotionName": { "type": "string", "description": "The name or title of the promotional offer associated with the promoCode.", "nullable": true }, "promotionExpirationDate": { "type": "string", "description": "A datetime attribute that indicates the expiration date of the promotional offer in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-10-21T18:10:00Z" }, "promotionDescription": { "type": "string", "description": "A string attribute that provides additional information about the promotion.", "nullable": true } } }, "supplies": { "$ref": "#/components/schemas/supplies" }, "productDetails": { "nullable": true, "type": "object", "description": "An object containing all details related to a product.", "properties": { "isPointOfSaleSoftware": { "type": "boolean", "description": "A boolean flag indicating whether the transaction or device is using a Software Point of Sale solution." }, "monerisAdvance": { "$ref": "#/components/schemas/monerisAdvance" }, "counterTopTerminals": { "$ref": "#/components/schemas/counterTopTerminals" }, "integratedProduct": { "$ref": "#/components/schemas/integratedProduct" }, "storeAndForward": { "$ref": "#/components/schemas/storeAndForward" }, "petroTrak": { "$ref": "#/components/schemas/petroTrak" }, "multiCurrency": { "$ref": "#/components/schemas/multiCurrencyProduct" }, "dynamicCurrencyConversion": { "$ref": "#/components/schemas/multiCurrencyProduct" }, "bookmark": { "$ref": "#/components/schemas/bookmark" }, "bookmarkPro": { "$ref": "#/components/schemas/bookmarkPro" }, "thirdPartyGiftCardFeeDetails": { "$ref": "#/components/schemas/thirdPartyGiftCardFeeDetails" }, "ueat": { "$ref": "#/components/schemas/ueat" }, "monerisGoAppetit": { "$ref": "#/components/schemas/monerisGoAppetit" }, "webCreationPackagesFeeDetails": { "$ref": "#/components/schemas/webCreationPackagesFeeDetails" }, "installmentsFeeDetails": { "$ref": "#/components/schemas/installmentsFeeDetails" }, "wixPointOfSale": { "$ref": "#/components/schemas/wixPointOfSale" }, "p2pe": { "$ref": "#/components/schemas/p2pe" }, "wireless": { "$ref": "#/components/schemas/wireless" }, "monerisGateway": { "$ref": "#/components/schemas/monerisGateway" }, "monerisGoPointOfSaleRetail": { "$ref": "#/components/schemas/monerisGoPointOfSaleRetail" }, "monerisGoPortal": { "$ref": "#/components/schemas/monerisGoPortal" }, "payDropPlus": { "$ref": "#/components/schemas/payDropPlus" } } }, "bankerInformation": { "nullable": true, "type": "object", "description": "An object containing all details related to banker information.", "properties": { "bankerEmail": { "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" }, "bankerEmployeeNumber": { "nullable": true, "type": "string", "description": "A string attribute that uniquely identifies the employee of the bank responsible.", "maxLength": 20, "example": "242200024" }, "bankerName": { "nullable": true, "type": "string", "description": "The full name of the banker representative.", "maxLength": 50, "example": "MONIKA CARNOKA" }, "bankerPhoneNumber": { "nullable": true, "type": "string", "description": "Phone number.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "bankerPhoneNumberExtension": { "nullable": true, "type": "string", "description": "The phone number extension of the banker representative.", "maxLength": 50, "pattern": "^[0-9]{1,6}$", "example": "1068" }, "bankerTransitNumber": { "nullable": true, "type": "string", "description": "The identifier of the transit bank associated.", "maxLength": 5, "example": "00160", "pattern": "^\\d{5}" }, "bankerBranchIdentifier": { "nullable": true, "type": "string", "description": "The branch identifier of the bank where the banker is located.", "maxLength": 5, "example": "2679" } } }, "cardPlanDetails": { "nullable": true, "type": "object", "description": "An object containing all the card plans details.", "properties": { "merchantDiscountRateType": { "$ref": "#/components/schemas/merchantDiscountRateType" }, "currency": { "nullable": true, "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" }, "transactionFeeParameterCode": { "$ref": "#/components/schemas/transactionFeeParameterCode" }, "cardBrandTemplateIdentifier": { "$ref": "#/components/schemas/cardBrandTemplateIdentifier" }, "selectedPlans": { "$ref": "#/components/schemas/selectedPlans" }, "mastercard": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "mastercardDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visa": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visaDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "discover": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "unionPay": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "interac": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "amex": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "otherFinancialInstitutionCards": { "$ref": "#/components/schemas/otherFinancialInstitutionCards" }, "programs": { "$ref": "#/components/schemas/programs" } } }, "pointOfSaleSolutionType": { "type": "string", "description": "Indicates the type of Point of Sale solution being used or requested.", "nullable": true, "enum": [ "POINT_OF_SALE_WITH_OFI", "MONERIS_POINT_OF_SALE", "PAPER_DEPOSIT" ] }, "deploymentTransactionNumber": { "type": "string", "description": "The transaction number associated with the deployment process.", "nullable": true }, "deploymentWorkOrderReference": { "type": "string", "description": "The work order number associated with the deployment process.", "nullable": true }, "deploymentWorkOrderStatus": { "type": "string", "description": "The work order status associated with the deployment process.", "nullable": true, "enum": [ "SHIPPED", "COMPLETE", "MAX_RETRIES_EXCEEDED", "CANCELLED", "ACCEPTED", "REJECTED", "SYSTEM_ERROR", "ON_HOLD" ] }, "shippedAt": { "type": "string", "description": "A datetime attribute that indicates the shipping date of the product or service in ISO 8601 format .", "nullable": true, "format": "date-time", "example": "2025-10-21T18:10:00Z" }, "shippingType": { "type": "string", "description": "A string attribute representing the type of shipping method used for delivering the product.", "nullable": true, "enum": [ "POINT_OF_SALE_AND_SUPPLIES", "SUPPLIES_ONLY" ] }, "shippingWayBillNumber": { "type": "string", "description": "The tracking number or waybill number assigned to the shipment.", "nullable": true }, "shippingCourierName": { "type": "string", "description": "The name of the shipping or courier company responsible for delivering the product or service.", "nullable": true }, "installedAt": { "type": "string", "description": "A date attribute representing the scheduled or actual date when the installation of a product or service is completed in ISO 8601 format.", "nullable": true, "format": "date", "example": "2025-10-21" }, "installationType": { "type": "string", "description": "The category of the installation process.", "nullable": true, "enum": [ "TRAIN_ONLY", "INSTALL", "INSTALL_AND_TRAIN" ] }, "installationMethod": { "type": "string", "description": "The method of the installation process.", "nullable": true, "enum": [ "PRO", "STANDARD", "ONSITE", "MERCHANT_INSTALL", "ONSITE_STANDARD_INSTALLATION", "ONSITE_PRO_INSTALLATION", "VIRTUAL_TRAINING_AND_SETUP_ASSISTANCE", "ONSITE_PREMIUM_INSTALLATION", "PREMIUM", "PHONE" ] }, "installationWorkOrderReference": { "type": "string", "description": "The work order of the installation process.", "nullable": true }, "isAcceptedByConduct": { "type": "boolean", "description": "Represents the acceptance of terms, conditions or agreement based on the actions of conduct of the parties involved." }, "contractSignatureRequired": { "type": "boolean", "description": "A boolean flag indicating whether a formal signature is required to validate or complete a contract." }, "faxRequired": { "type": "boolean", "description": "A boolean flag indicating whether faxing a document is necessary." }, "additionalInformation": { "type": "string", "description": "A general purpose attribute used to represent additional information.", "nullable": true }, "businessEntityName": { "type": "string", "description": "The name of the business entity.", "nullable": true }, "readyAt": { "type": "string", "description": "Refers to the date when a product, service, or order is expected to be ready in ISO 8601 format.", "nullable": true, "format": "date-time", "example": "2025-10-21T18:10:00Z" }, "isMerchantReadyToAccept": { "type": "boolean", "description": "Indicates whether the merchant is prepared to accept the order." }, "applicationScore": { "type": "integer", "description": "The categorical score assigned to an application.", "format": "int64" }, "marginValue": { "type": "string", "description": "The specific metric related to the margin value.", "nullable": true }, "priorityTier": { "type": "string", "description": "The priority level assigned to an order.", "nullable": true, "enum": [ "ONE", "TWO", "THREE", "FOUR" ] }, "referralInformation": { "type": "object", "description": "An object containing information related to the referral process.", "nullable": true, "properties": { "partnerName": { "$ref": "#/components/schemas/partnerName" }, "transitNumber": { "type": "string", "description": "The transit number of the partner that referred the lead to the business.", "nullable": true }, "employeeFirstName": { "type": "string", "description": "The first name of the partner that referred the lead to the business.", "nullable": true }, "employeeLastName": { "type": "string", "description": "The last name of the partner that referred the lead to the business.", "nullable": true }, "description": { "type": "string", "description": "The details of the partner that referred the lead to the business.", "nullable": true }, "additionalInformation": { "type": "string", "description": "The additional information of the partner that referred the lead to the business.", "nullable": true } } }, "hostType": { "type": "string", "description": "The category of host that the service is running on.", "nullable": true, "enum": [ "ESSENTIS", "OTHER" ] }, "isExpeditedOrder": { "type": "boolean", "description": "A boolean flag indicting whether an order is being processed with an expedited status." }, "autoApprovalStatus": { "type": "string", "description": "The status of an automatic approval process of an order.", "nullable": true, "enum": [ "CONDITIONALLY_APPROVED", "MANUAL", "MANUAL_ADJUDICATION", "NOT_APPLICABLE", "PENDING_ADJUDICATION", "PROCESSING" ] }, "adjudicationApprovalStatus": { "nullable": true, "type": "string", "description": "The status that indicates whether an order has been approved or rejected during adjudication process.", "example": "MANUAL", "enum": [ "AUTOMATIC", "MANUAL", "PENDING_ADJUDICATION" ] }, "hasImprinter": { "type": "boolean", "description": "A boolean flag indicating whether an imprinter is available in the transaction process." }, "isMarketSubSegmentationPreApprovalRequired": { "type": "boolean", "description": "The attribute related to pre-approval of market segmentation." }, "optOutAmexCommunication": { "type": "boolean", "description": "A boolean flag indicating whether a customer has opted out of receiving communications from American Express." }, "multiCurrencyPricingPackageId": { "type": "integer", "description": "The identifier associated with a package.", "format": "int64" }, "deliveryAddressConfirmed": { "type": "boolean", "description": "A boolean flag indicating whether the delivery address has been confirmed." }, "isManualDeploymentRequired": { "type": "boolean", "description": "Indicates whether a process deployment needs to be performed manually." }, "isDeficient": { "type": "boolean", "description": "Indicates whether something is lacking or deficient related to the order." }, "preDeficientOrderStatus": { "type": "string", "description": "The status of an order before it is flagged as deficient.", "nullable": true, "enum": [ "ADJUDICATION", "COLLATERAL_REQUIRED", "COMPLIANCE", "COMPLETE", "DEPLOYMENT", "FINAL_ACI_MERCHANT_UPDATE", "IN_PROGRESS", "MANUAL_ADJUDICATION", "MANUAL_ADJUDICATION_REVIEW", "ONE_TIME_FEE", "POST_BOARDING_DP_FLOW", "READJUDICATION", "READJUDICATION_FLOW", "SCHEDULE_INSTALL", "SALES_ACTIVATION_BASE24", "SALES_ACTIVATION_POST_DEPLOYMENT", "SALES_APPROVAL", "START_ORDER", "UPDATE_ORDER" ] } } }, "orderCreatedBy": { "type": "string", "description": "The individual responsible for creating the order.", "nullable": true, "maxLength": 100, "example": "pcote03@PERCOM-> PERCOMpcote03" }, "orderId": { "type": "string", "description": "Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction\n\n**Note**: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.\n", "minLength": 1, "maxLength": 50, "example": "1q2w3e4r5t6t78", "pattern": "^[a-zA-Z0-9-_]+$", "nullable": true }, "orderStatus": { "type": "string", "description": "Represents the current status of the order in the system.", "nullable": true, "enum": [ "COMPLETED", "DECLINED", "DEPLOYMENT", "APPLICATION_SUBMITTED", "CREDIT_ADJUDICATION", "DECLINED_APPLICATION", "CREDIT_ADJUDICATION_REVIEW", "SCHEDULE_POS_INSTALL" ] }, "originalAmount": { "type": "object", "nullable": true, "description": "Original amount for the first transaction in the series. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 15000, "currency": "CAD" } }, "originatedFromCallCenter": { "description": "Refers to Kount's Call center indicator. \n\nFlag indicating whether risk inquiry request originates from a call center environment If the customer service agents navigate to a separate order entry page that does not collect iframe data: When sending the kount_inquiry request, set call_center_ind to Y If the customer service agents navigate to the same order entry page as the customer: When sending the kount_inquiry request, set call_center_ind to N If Risk Inquiry Service call does not originate from a call center environment, set call_center_ind to N\n\nTrue for YES, False fo NO\n", "type": "boolean" }, "otherFinancialInstitutionCardType": { "type": "string", "description": "Represents the specific type of card used within the OFI institution card plan.", "nullable": true, "enum": [ "AMEX", "CHEQUE_AUTHORIZATION", "DINERS", "DISCOVER", "MASTERCARD", "VISA" ] }, "otherFinancialInstitutionCards": { "type": "array", "description": "A list of other financial institution cards.", "items": { "$ref": "#/components/schemas/ofiCardPlan" }, "maxItems": 20 }, "p2pe": { "type": "object", "description": "An object containing details about the P2PE product.", "nullable": true, "properties": { "transactionVolume": { "type": "integer", "description": "The transaction volume for the P2PE product.", "format": "int32", "minimum": 1, "maximum": 1000000 }, "quantity": { "type": "integer", "description": "The quantity of P2PE devices.", "format": "int32", "minimum": 1, "maximum": 100 }, "feeDetails": { "type": "object", "description": "An object representing the fees associated with the P2PE product.", "nullable": true, "properties": { "indoorFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "outdoorFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "transactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "solutionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } } } }, "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" ] }, "partnerName": { "type": "string", "description": "The name of the partner that referred the lead to the business.", "nullable": true, "maxLength": 30 }, "pauseSubscriptionRequest": { "title": "pauseSubscriptionRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey" ] }, "payDropPlus": { "type": "object", "description": "An object containing the PayD Pro Plus details.", "nullable": true, "properties": { "feeDetails": { "$ref": "#/components/schemas/payDropPlusFeeDetails" } } }, "payDropPlusFeeDetails": { "type": "object", "description": "A list of fees associated with PayD Pro Plus.", "nullable": true, "properties": { "subTotalFee": { "description": "The sum of all applicable fees before any additional charges.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "payment": { "title": "payment", "type": "object", "description": "Returns a processed payment", "properties": { "paymentId": { "$ref": "#/components/schemas/paymentId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "transactionDateTime": { "$ref": "#/components/schemas/transactionDateTime" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "amount": { "description": "This amount excludes surcharge, application and convenience fee.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "authorizedAmount": { "description": "This represents the funds that are held by the authorization on the payment method.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "capturableAmount": { "description": "Remaining amount that can still be captured.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "amountDetails": { "$ref": "#/components/schemas/amountDetails" }, "convenienceFeeDetails": { "$ref": "#/components/schemas/convenienceFeeDetails" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "paymentStatus": { "$ref": "#/components/schemas/paymentStatus" }, "transactionDetails": { "$ref": "#/components/schemas/statusDetails" }, "verificationDetails": { "$ref": "#/components/schemas/verificationDetails" }, "credentialOnFileResponse": { "$ref": "#/components/schemas/credentialOnFileResponse" }, "multiCurrencyPricingDetails": { "$ref": "#/components/schemas/multiCurrencyPricingDetails" }, "refundDetails": { "$ref": "#/components/schemas/refundDetails" }, "subscription": { "$ref": "#/components/schemas/subscriptionReference" }, "installmentPlanDetails": { "$ref": "#/components/schemas/installmentPlanDetails" }, "customData": { "$ref": "#/components/schemas/customData" }, "incrementalAuthorizations": { "$ref": "#/components/schemas/incrementalAuthorizations" }, "multipleCompletions": { "$ref": "#/components/schemas/multipleCompletions" } }, "required": [ "paymentId", "merchantId", "transactionDateTime", "createdAt", "amount", "authorizedAmount", "capturableAmount", "paymentMethod", "paymentStatus", "transactionDetails", "verificationDetails" ] }, "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" }, "paymentId": { "type": "string", "description": "Unique Identification for the Payment", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "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" }, "paymentList": { "title": "paymentList", "type": "object", "description": "Response body, returns a paginated list of payments", "properties": { "data": { "description": "Payments list.", "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/payment" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "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/cardPaymentMethodInformation" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "paymentMethodId", "merchantId", "paymentMethodInformation", "createdAt" ] }, "paymentMethodCard": { "title": "paymentMethodCard", "description": "Credit/Debit/Gift Card payment method details.", "allOf": [ { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/card" } }, "required": [ "card" ] }, { "$ref": "#/components/schemas/paymentMethodRequestBase" } ], "required": [ "paymentMethodSource", "card" ] }, "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" }, "paymentMethodList": { "description": "List of Payment Methods", "type": "object", "title": "paymentMethodList", "properties": { "data": { "description": "Payment Method list", "type": "array", "items": { "$ref": "#/components/schemas/paymentMethod" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "paymentMethodPermanentToken": { "title": "paymentMethodPermanentToken", "description": "A Permanent Token is issued by Moneris to the merchant and represents the card details. This option is used for legacy purposes.\n", "allOf": [ { "type": "object", "properties": { "permanentToken": { "$ref": "#/components/schemas/token" } }, "required": [ "permanentToken" ] }, { "$ref": "#/components/schemas/paymentMethodRequestBase" } ], "required": [ "paymentMethodSource", "permanentToken" ] }, "paymentMethodRequest": { "title": "paymentMethodRequest", "description": "Payment method details", "oneOf": [ { "$ref": "#/components/schemas/paymentMethodWithId" }, { "$ref": "#/components/schemas/paymentMethodCard" }, { "$ref": "#/components/schemas/paymentMethodTemporaryToken" }, { "$ref": "#/components/schemas/paymentMethodPermanentToken" }, { "$ref": "#/components/schemas/applePayDecryptedWallet" }, { "$ref": "#/components/schemas/applePayEncryptedWallet" }, { "$ref": "#/components/schemas/googlePayDecryptedWallet" }, { "$ref": "#/components/schemas/googlePayEncryptedWallet" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "PAYMENT_METHOD_ID": "#/components/schemas/paymentMethodWithId", "CARD": "#/components/schemas/paymentMethodCard", "TEMPORARY_TOKEN": "#/components/schemas/paymentMethodTemporaryToken", "PERMANENT_TOKEN": "#/components/schemas/paymentMethodPermanentToken", "APPLE_PAY_ENCRYPTED": "#/components/schemas/applePayEncryptedWallet", "APPLE_PAY_DECRYPTED": "#/components/schemas/applePayDecryptedWallet", "GOOGLE_PAY_ENCRYPTED": "#/components/schemas/googlePayEncryptedWallet", "GOOGLE_PAY_DECRYPTED": "#/components/schemas/googlePayDecryptedWallet" } }, "required": [ "paymentMethodSource" ] }, "paymentMethodRequestBase": { "description": "Payment Method details.\n\nNote: If defined, this will result in the creation of Payment Method as defined in the Payment Method API.\n", "type": "object", "properties": { "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" } }, "paymentMethodSource": { "$ref": "#/components/schemas/paymentMethodRequestSource" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "paymentMethodSource" ] }, "paymentMethodRequestSource": { "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", "enum": [ "PAYMENT_METHOD_ID", "CARD", "TEMPORARY_TOKEN", "PERMANENT_TOKEN", "APPLE_PAY_ENCRYPTED", "APPLE_PAY_DECRYPTED", "GOOGLE_PAY_ENCRYPTED", "GOOGLE_PAY_DECRYPTED" ] }, "paymentMethodTemporaryToken": { "title": "paymentMethodTemporaryToken", "description": "A Temporary Token is issued by Moneris to the merchant and represents the card details. Please review the Hosted Tokenization feature documentation to learn how to issue such a token.\n", "allOf": [ { "type": "object", "properties": { "temporaryToken": { "$ref": "#/components/schemas/token" } }, "required": [ "paymentMethodSource", "temporaryToken" ] }, { "$ref": "#/components/schemas/paymentMethodRequestBase" } ], "required": [ "paymentMethodSource", "temporaryToken" ] }, "paymentMethodWithId": { "title": "paymentMethodWithId", "description": "Use existing unique payment method identifier.", "properties": { "paymentMethodSource": { "$ref": "#/components/schemas/paymentMethodRequestSource" }, "paymentMethodId": { "$ref": "#/components/schemas/paymentMethodId" } }, "required": [ "paymentMethodSource", "paymentMethodId" ] }, "paymentModeCode": { "type": "string", "description": "The type of payment mode associated with a transaction under the transaction plan.", "nullable": true, "maxLength": 10 }, "paymentReference": { "description": "Payment reference. Can be expanded into full payment details using the expand query parameter.", "type": "object", "nullable": true, "properties": { "paymentId": { "$ref": "#/components/schemas/paymentId" }, "href": { "$ref": "#/components/schemas/paymentUri" } }, "required": [ "paymentId" ] }, "paymentStatus": { "type": "string", "description": "Payment Status description.", "enum": [ "CANCELED", "DECLINED", "DECLINED_RETRY", "AUTHORIZED", "PROCESSING", "SUCCEEDED", "INCREMENTED", "PARTIALLY_COMPLETED" ], "example": "SUCCEEDED" }, "paymentToken": { "description": "Payment token submitted by merchant for order (credit card, payer ID, routing/transit, MICR, and account number).\n\nIf paymentType is set to NONE then the paymentToken value should be left empty (NULL).\n\nIf the credit card information is not available and Moneris Tokenization is used to process payment set paymentType = CARD and send the token in the paymentToken field.\n", "type": "string", "maxLength": 32, "example": "4242424242424242" }, "paymentType": { "description": "Payment Type submitted by merchant. \n\nIf the credit card information is not available and Moneris Tokenization is used to process payment set paymentType = CARD and send the token in the paymentToken field.\n", "type": "string", "enum": [ "APPLE_PAY", "CARD", "PAYPAL", "CHECK", "NONE", "GREEN_DOT_MONEY_PACK", "BILL_ME_LATER", "GIFT_CARD", "BPAY", "NETELLER", "GIROPAY", "ELV", "MERCADE_PAGO", "SINGLE_EURO_PAYMENT_AREA", "INTERAC", "CARTE_BLEUE", "POLI", "SKRILL_MONEY_BOOKERS", "SOFORT" ] }, "paymentUri": { "title": "Payment URI", "nullable": true, "description": "Payment Reference URL", "type": "string", "format": "uri-reference", "example": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "petroTrak": { "type": "object", "description": "An object containing details about the PetroTrak product.", "nullable": true, "properties": { "feeDetails": { "type": "object", "nullable": true, "description": "An object representing the fees associated with the PetroTrak product.", "properties": { "receivableAccountsTransactionFee": { "description": "A fee applied to accounts receivable transactions.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "softwareFee": { "description": "A fee applied for the use of software related to the PetroTrak product.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "deviceOwnershipName": { "type": "string", "nullable": true, "description": "The name of the device ownership for the PetroTrak product.", "maxLength": 100 }, "siteNumber": { "type": "string", "nullable": true, "description": "The site number associated with the PetroTrak product.", "maxLength": 50 }, "corporateBrand": { "type": "string", "nullable": true, "description": "The corporate brand associated with the PetroTrak product.", "maxLength": 50 }, "profileIdentifier": { "type": "string", "nullable": true, "description": "A unique identifier for the PetroTrak profile.", "maxLength": 50 }, "profileName": { "type": "string", "nullable": true, "description": "The name of the PetroTrak profile.", "maxLength": 100 }, "lines": { "type": "array", "description": "A list of lines associated with the PetroTrak product.", "maxItems": 50, "items": { "type": "object", "properties": { "binRange": { "type": "string", "nullable": true, "maxLength": 255, "description": "The range of BINs (Bank Identification Numbers) associated with the PetroTrak product." }, "lowPrefix": { "type": "string", "nullable": true, "description": "The low prefix associated with the PetroTrak product.", "maxLength": 50 }, "highPrefix": { "type": "string", "nullable": true, "description": "The high prefix associated with the PetroTrak product.", "maxLength": 50 }, "service": { "type": "string", "nullable": true, "description": "The service type associated with the PetroTrak product.", "maxLength": 50 }, "discountRate": { "type": "string", "nullable": true, "description": "The discount rate type associated with the PetroTrak product.", "maxLength": 50 }, "discountRateValue": { "nullable": true, "description": "The discount rate value associated with the PetroTrak product.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } } }, "terminals": { "type": "array", "description": "A list of payment terminals available for the PetroTrak product.", "items": { "$ref": "#/components/schemas/terminal" }, "maxItems": 21 } } }, "phoneNumber": { "type": "string", "description": "Phone number.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "pinpadCableType": { "type": "string", "description": "Specifies the type of the cable used to connect the PIN pad to the terminal.", "nullable": true, "maxLength": 50 }, "pinpadModel": { "type": "string", "description": "Specifies the model or type of the PIN pad component integrated with the terminal.", "maxLength": 50, "nullable": true }, "pinpadType": { "type": "string", "description": "The type of pinpad associated with the device.", "nullable": true }, "pointOfSaleType": { "type": "string", "description": "Specifies the type of point of sale terminal being used.", "nullable": true, "maxLength": 50 }, "postalCode": { "type": "string", "description": "Postal or zip code", "minLength": 1, "maxLength": 30, "example": "M8X 2X2" }, "previous": { "description": "Pagination link pointing to the previous page.", "type": "string", "format": "uri-reference", "nullable": true }, "pricingModel": { "type": "string", "description": "Defines the pricing structure for the services provided.", "nullable": true, "maxLength": 30 }, "processedAt": { "description": "Time at which the object was processed", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "productDetails": { "type": "object", "description": "An object containing all details related to a product.", "properties": { "isPointOfSaleSoftware": { "type": "boolean", "description": "A boolean flag indicating whether the transaction or device is using a Software Point of Sale solution." }, "monerisAdvance": { "$ref": "#/components/schemas/monerisAdvance" }, "counterTopTerminals": { "$ref": "#/components/schemas/counterTopTerminals" }, "integratedProduct": { "$ref": "#/components/schemas/integratedProduct" }, "storeAndForward": { "$ref": "#/components/schemas/storeAndForward" }, "petroTrak": { "$ref": "#/components/schemas/petroTrak" }, "multiCurrency": { "$ref": "#/components/schemas/multiCurrencyProduct" }, "dynamicCurrencyConversion": { "$ref": "#/components/schemas/multiCurrencyProduct" }, "bookmark": { "$ref": "#/components/schemas/bookmark" }, "bookmarkPro": { "$ref": "#/components/schemas/bookmarkPro" }, "thirdPartyGiftCardFeeDetails": { "$ref": "#/components/schemas/thirdPartyGiftCardFeeDetails" }, "ueat": { "$ref": "#/components/schemas/ueat" }, "monerisGoAppetit": { "$ref": "#/components/schemas/monerisGoAppetit" }, "webCreationPackagesFeeDetails": { "$ref": "#/components/schemas/webCreationPackagesFeeDetails" }, "installmentsFeeDetails": { "$ref": "#/components/schemas/installmentsFeeDetails" }, "wixPointOfSale": { "$ref": "#/components/schemas/wixPointOfSale" }, "p2pe": { "$ref": "#/components/schemas/p2pe" }, "wireless": { "$ref": "#/components/schemas/wireless" }, "monerisGateway": { "$ref": "#/components/schemas/monerisGateway" }, "monerisGoPointOfSaleRetail": { "$ref": "#/components/schemas/monerisGoPointOfSaleRetail" }, "monerisGoPortal": { "$ref": "#/components/schemas/monerisGoPortal" }, "payDropPlus": { "$ref": "#/components/schemas/payDropPlus" } } }, "productRecommendation": { "type": "object", "description": "An object containing all details related to a product recommendation.", "properties": { "allowToSell": { "type": "boolean", "description": "A boolean value indicating whether the business is allowed to sell the solution." }, "solutions": { "type": "array", "description": "A list of solution items.", "items": { "$ref": "#/components/schemas/solution" } } } }, "productRecommendationRequest": { "type": "object", "required": [ "annualVolume", "hasMajorityOwnership", "hasExistingRelationship", "hasMultipleLocations", "locationProvince", "merchantCategoryCode" ], "description": "Recommender products payload attributes", "properties": { "partnerName": { "$ref": "#/components/schemas/partnerName" }, "annualVolume": { "$ref": "#/components/schemas/annualVolume" }, "hasMajorityOwnership": { "$ref": "#/components/schemas/hasMajorityOwnership" }, "hasExistingRelationship": { "$ref": "#/components/schemas/hasExistingRelationship" }, "hasMultipleLocations": { "$ref": "#/components/schemas/hasMultipleLocations" }, "locationProvince": { "$ref": "#/components/schemas/province" }, "merchantCategoryCode": { "$ref": "#/components/schemas/merchantCategoryCode" }, "solutionId": { "$ref": "#/components/schemas/solutionId" }, "isAllowedToSell": { "$ref": "#/components/schemas/isAllowedToSell" }, "isOnline": { "$ref": "#/components/schemas/isOnline" }, "isInstore": { "$ref": "#/components/schemas/isInstore" }, "directSellingPercentage": { "$ref": "#/components/schemas/directSellingPercentage" }, "motoTransactionPercentage": { "$ref": "#/components/schemas/motoTransactionPercentage" }, "ecommerceTransactionPercentage": { "$ref": "#/components/schemas/ecommerceTransactionPercentage" } } }, "programs": { "type": "array", "description": "A list of programs associated with the card plan.", "maxItems": 6, "uniqueItems": true, "items": { "type": "string", "enum": [ "AMEX_EXPRESS", "DISCOVER_ZIP", "INTERAC_FLASH", "MASTERCARD_PAY_PASS", "UNION_PAY_QUICK_PASS", "VISA_VEPS" ] } }, "province": { "type": "string", "description": "Province or state ISO 3166-2 code ", "minLength": 1, "maxLength": 3, "format": "iso-3166-2", "example": "ON" }, "quantity": { "type": "integer", "description": "Specifies the amount of goods currently available for a particular product.", "format": "int32", "minimum": 1, "maximum": 100, "example": 1 }, "refund": { "title": "refundResponse", "type": "object", "properties": { "refundId": { "$ref": "#/components/schemas/refundId" }, "payment": { "$ref": "#/components/schemas/paymentReference" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "refundAmount": { "$ref": "#/components/schemas/refundAmount" }, "amountDetails": { "description": "Contains information pertaining to the surcharge amount of a Payment.", "nullable": true, "type": "object", "properties": { "surchargeAmount": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "refundStatus": { "$ref": "#/components/schemas/refundStatus" }, "transactionDetails": { "$ref": "#/components/schemas/statusDetails" }, "reason": { "description": "Reason for the refund.", "type": "string", "minLength": 1, "maxLength": 100, "example": "Defective product", "nullable": true }, "credentialOnFileResponse": { "$ref": "#/components/schemas/credentialOnFileResponse" }, "multiCurrencyPricingDetails": { "$ref": "#/components/schemas/multiCurrencyPricingDetails" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "refundId", "merchantId", "paymentMethod", "createdAt", "refundAmount", "refundStatus", "transactionDetails" ] }, "refundAmount": { "type": "object", "description": "Refund amount for the transaction. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 17500, "currency": "CAD" } }, "refundDetails": { "description": "Refund details if any has occured.", "type": "object", "nullable": true, "properties": { "refunds": { "description": "List of Refunds associated with this Payment", "type": "array", "items": { "$ref": "#/components/schemas/refundReference" } }, "refundedAmount": { "$ref": "#/components/schemas/money" } }, "required": [ "refundedAmount" ] }, "refundId": { "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "description": "Unique Identification for the Refund", "example": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "refundList": { "title": "refundList", "type": "object", "properties": { "data": { "description": "List of refunds.", "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/refund" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "refundReference": { "description": "Refund reference.", "type": "object", "nullable": true, "properties": { "refundId": { "$ref": "#/components/schemas/refundId" }, "href": { "$ref": "#/components/schemas/refundUri" } }, "required": [ "refundId" ] }, "refundStatus": { "type": "string", "description": "Refund Status description.", "enum": [ "DECLINED", "DECLINED_RETRY", "PROCESSING", "SUCCEEDED" ], "example": "SUCCEEDED" }, "refundUri": { "title": "Refund URI", "description": "Refund Reference URL", "type": "string", "nullable": true, "format": "uri-reference", "example": "/refunds/ri0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "region": { "type": "string", "description": "Specify the geographical area, province or territory relevant to the operation.", "nullable": true, "maxLength": 10 }, "representativeCode": { "type": "string", "description": "A code that identifies the representative agent associated with the order.", "nullable": true, "maxLength": 10, "example": "A0" }, "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" }, "responseCode": { "type": "string", "description": "\"Details Transaction Response Codes:\n- **< 50**: Transaction approved\n- **> 50**: Transaction declined\nNULL: Transaction not sent for authorization\nFor a complete list of definitions, refer to the Response Codes Table\"\n", "minLength": 3, "maxLength": 3, "example": "001" }, "resumeSubscriptionRequest": { "title": "resumeSubscriptionRequest", "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "idempotencyKey" ] }, "riskLevel": { "type": "string", "description": "The risk level associated with the business.", "nullable": true, "enum": [ "LOW", "MEDIUM", "HIGH" ], "example": "LOW" }, "securityDetails": { "type": "object", "description": "An object containing all details about the security details.", "required": [ "legalEntity", "signingOfficers" ], "properties": { "legalEntity": { "$ref": "#/components/schemas/legalEntity" }, "signingOfficers": { "type": "array", "description": "A list of signing officer entities.", "maxItems": 100, "items": { "$ref": "#/components/schemas/signingOfficer" } } } }, "selectedPlans": { "type": "array", "description": "A list of selected plans associated with the card plan.", "maxItems": 8, "uniqueItems": true, "items": { "type": "string", "enum": [ "AMEX", "DISCOVER", "INTERAC", "MASTERCARD", "MASTERCARD_DEBIT", "UNION_PAY", "VISA", "VISA_DEBIT" ] } }, "self": { "description": "Pagination link pointing to the current page.", "type": "string", "format": "uri-reference", "nullable": true }, "serviceCode": { "type": "string", "description": "The service code associated with the device.", "nullable": true }, "serviceDeliverToCanadaAvailable": { "type": "boolean", "description": "A boolean value indicating whether the business is available for delivery to Canada." }, "serviceDeliverToUSAvailable": { "type": "boolean", "description": "A boolean value indicating whether the business is available for delivery to US." }, "serviceFeeDetails": { "type": "object", "description": "An object containing the service fees details.", "nullable": true, "properties": { "authorizationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "maintenanceFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "serviceProvider": { "type": "string", "description": "The name or identifier of the service provider associated to the business.", "nullable": true, "maxLength": 255, "example": "moneris.com" }, "sessionId": { "description": "Unique Session ID; must be unique over a 30-day span", "type": "string", "maxLength": 32, "example": "xjudq804i1049jkjakdad" }, "settlementOption": { "type": "string", "description": "The method for settling transactions.", "enum": [ "SYSTEM_CLOSE", "MERCHANT_CLOSE" ] }, "settlementTime": { "nullable": true, "type": "string", "description": "A timestamp indicating the time when a transaction is settled.", "format": "time", "example": "18:10:00" }, "shippingType": { "description": "Shipping type. The following nomenclature is expected for shipping types to be passed to Kount. NOTE:These three attributes can be used to pass custom attribute data if you want to correlate some data with the returned response", "type": "string", "nullable": true, "enum": [ "SAME_DAY", "NEXT_DAY", "SECOND_DAY", "STANDARD", null ] }, "signingOfficer": { "type": "object", "description": "An object containing all details about the signing officer of the business.", "required": [ "creditReportAllowed", "firstName", "lastName", "address", "dateOfBirth", "ownershipPercentage", "title" ], "properties": { "signingOfficerIdentifier": { "description": "A unique identifier for the signing officer.", "type": "integer", "format": "int64" }, "creditReportAllowed": { "type": "boolean", "description": "A boolean value indicating whether the business has authorized the review of its credit report." }, "firstName": { "description": "The first name of the signing officer.", "type": "string", "minLength": 1, "maxLength": 30, "example": "John", "nullable": true }, "lastName": { "description": "The last name of the signing officer.", "type": "string", "minLength": 1, "maxLength": 30, "example": "Doe", "nullable": true }, "address": { "$ref": "#/components/schemas/address" }, "dateOfBirth": { "description": "The date of birth of the signing officer.", "type": "string", "format": "date", "example": "2019-07-30" }, "ownershipPercentage": { "description": "A numeric value representing the percentage of ownership held by an individual in the business.", "type": "number", "format": "decimal", "minimum": 0, "maximum": 100, "example": 90.5 }, "title": { "description": "The official position of the signing officer within the business.", "type": "string", "maxLength": 60, "enum": [ "OWNER", "PRESIDENT", "VICE_PRESIDENT", "SECRETARY", "TREASURER", "DIRECTOR", "OTHER" ] }, "merchantRiskRate": { "nullable": true, "type": "string", "description": "A score indicating the level of risk associated with the merchant's transactions.", "maxLength": 60, "example": "A+", "enum": [ "A", "A_PLUS", "B_HIGH", "B_LOW", "B_LOW_PLUS", "B_MID", "C", "C_HIGH", "C_HIGH_PLUS", "C_LOW", "C_LOW_PLUS", "C_MID", "C_MID_PLUS", "C_PLUS", "D", "D_HIGH", "D_LOW", "D_MID", "E", "E_MINUS", "F" ] } } }, "software": { "type": "string", "description": "Indicates the software version or platform running on the terminal device.", "maxLength": 255, "nullable": true }, "softwareVendors": { "type": "array", "description": "A list of software vendors associated with the device.", "items": { "type": "string" } }, "solution": { "type": "object", "description": "An object containing all details related to a solution.", "required": [ "solutionIdentifier", "solutionName", "solutionDescription", "solutionImageUrl" ], "properties": { "solutionIdentifier": { "type": "integer", "description": "The unique identifier for the solution.", "format": "int32" }, "solutionName": { "type": "string", "description": "The name of the solution." }, "solutionDescription": { "type": "string", "description": "A detailed description of the solution." }, "solutionImageUrl": { "type": "string", "description": "The URL of the image associated with the solution." }, "solutionPrices": { "type": "array", "description": "A list of pricing options associated with the solution.", "items": { "$ref": "#/components/schemas/solutionPricing" } }, "solutionFeatures": { "type": "array", "description": "A list of features associated with the solution.", "items": { "$ref": "#/components/schemas/solutionFeature" } }, "promotionalBlock": { "type": "string", "description": "A promotional block associated with the solution.", "nullable": true }, "additionalSolutionDetailsUrl": { "type": "string", "description": "The URL for additional details about the solution.", "nullable": true }, "maximumQuantity": { "type": "integer", "description": "The maximum quantity of the solution that can be purchased.", "format": "int32" }, "carrierOptions": { "type": "array", "description": "A list of carrier options available for the solution.", "items": { "type": "string" } } } }, "solutionDetails": { "type": "object", "description": "An object containing the solutions details.", "properties": { "solutionId": { "$ref": "#/components/schemas/solutionId" }, "quantity": { "description": "The number of items provided within the solution.", "type": "integer", "format": "int32", "minimum": 1, "maximum": 99, "example": 21 }, "carrier": { "description": "A string that identifies the provider responsible for delivering the solution.", "nullable": true, "type": "string", "enum": [ "ROGERS", "TELUS" ] } }, "required": [ "solutionId", "quantity" ] }, "solutionFeature": { "type": "object", "description": "An object containing all details related to a feature of a solution.", "required": [ "description" ], "properties": { "description": { "type": "string", "description": "A detailed description of the feature." } } }, "solutionId": { "description": "A unique identifier for the solutions object.", "type": "integer", "format": "int32", "example": 1 }, "solutionPricing": { "type": "object", "description": "An object containing all details related to a pricing option for a solution.", "required": [ "pricingLabel", "pricingText" ], "properties": { "pricingLabel": { "type": "string", "description": "The label associated with the pricing option." }, "pricingText": { "type": "string", "description": "The text associated with the pricing option." } } }, "solutions": { "type": "array", "description": "A list of solution items.", "items": { "$ref": "#/components/schemas/solutionDetails" }, "maxItems": 5 }, "statusDetails": { "type": "object", "description": "Additional details about the transaction outcome.", "properties": { "transactionUniqueId": { "type": "string", "description": "Realtime transaction identifier from the host.", "nullable": true }, "isoResponseCode": { "$ref": "#/components/schemas/iso" }, "responseCode": { "$ref": "#/components/schemas/responseCode" }, "authorizationCode": { "$ref": "#/components/schemas/authorizationCode" }, "message": { "$ref": "#/components/schemas/message" }, "ecommerceIndicator": { "$ref": "#/components/schemas/ecommerceIndicator" } }, "required": [ "isoResponseCode", "responseCode", "ecommerceIndicator" ] }, "storeAndForward": { "type": "object", "description": "An object containing details about the Store and Forward product.", "nullable": true, "properties": { "isEnabled": { "type": "boolean", "description": "A boolean flag indicating whether the Store and Forward product is enabled." }, "storedCumulativeTransactionVolume": { "type": "integer", "description": "A string representing the cumulative transaction volume stored in the Store and Forward product.", "format": "int32" }, "maximumStoredTransactionAmount": { "description": "The maximum amount that can be stored in the Store and Forward product.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "storeApplePayDecryptedWalletRequest": { "title": "storeApplePayDecryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/applePayDecryptedWallet" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storeApplePayEncryptedWalletRequest": { "title": "storeApplePayEncryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/applePayEncryptedWallet" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storeGooglePayDecryptedWalletRequest": { "title": "storeGooglePayDecryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/googlePayDecryptedWallet" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storeGooglePayEncryptedWalletRequest": { "title": "storeGooglePayEncryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/googlePayEncryptedWallet" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "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" ] }, "storePaymentMethodCardRequest": { "title": "storePaymentMethodCardRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodCard" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storePaymentMethodIdRequest": { "title": "storePaymentMethodIdRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodWithId" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storePaymentMethodPermanentTokenRequest": { "title": "storePaymentMethodPermanentTokenRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodPermanentToken" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePermanentToken" }, "credentialOnFileInformation": { "$ref": "#/components/schemas/credentialOnFileInformation" } }, "required": [ "credentialOnFileInformation" ] } ] }, "storePaymentMethodRequest": { "title": "storePaymentMethodRequest", "description": "Used to collect payment data needed to execute the transaction. \nCan also be used to collect and save customer payment instruments on file. \n", "oneOf": [ { "$ref": "#/components/schemas/storePaymentMethodIdRequest" }, { "$ref": "#/components/schemas/storePaymentMethodCardRequest" }, { "$ref": "#/components/schemas/storePaymentMethodTemporaryTokenRequest" }, { "$ref": "#/components/schemas/storePaymentMethodPermanentTokenRequest" }, { "$ref": "#/components/schemas/storeApplePayDecryptedWalletRequest" }, { "$ref": "#/components/schemas/storeApplePayEncryptedWalletRequest" }, { "$ref": "#/components/schemas/storeGooglePayDecryptedWalletRequest" }, { "$ref": "#/components/schemas/storeGooglePayEncryptedWalletRequest" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "PAYMENT_METHOD_ID": "#/components/schemas/storePaymentMethodIdRequest", "CARD": "#/components/schemas/storePaymentMethodCardRequest", "TEMPORARY_TOKEN": "#/components/schemas/storePaymentMethodTemporaryTokenRequest", "PERMANENT_TOKEN": "#/components/schemas/storePaymentMethodPermanentTokenRequest", "APPLE_PAY_ENCRYPTED": "#/components/schemas/storeApplePayEncryptedWalletRequest", "APPLE_PAY_DECRYPTED": "#/components/schemas/storeApplePayDecryptedWalletRequest", "GOOGLE_PAY_ENCRYPTED": "#/components/schemas/storeGooglePayEncryptedWalletRequest", "GOOGLE_PAY_DECRYPTED": "#/components/schemas/storeGooglePayDecryptedWalletRequest" } }, "required": [ "paymentMethodSource" ] }, "storePaymentMethodTemporaryTokenRequest": { "title": "storePaymentMethodTemporaryTokenRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodTemporaryToken" }, { "type": "object", "properties": { "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" }, "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "storePermanentToken": { "description": "Store this payment method created through this payment for future use. \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": "MERCHANT_INITIATED", "enum": [ "CARDHOLDER_INITIATED", "MERCHANT_INITIATED" ] }, "streetName": { "type": "string", "description": "Street name", "minLength": 1, "maxLength": 100, "example": "Bloor" }, "streetNumber": { "type": "string", "description": "Street number", "minLength": 1, "maxLength": 19, "example": "3300" }, "subTotalAmount": { "type": "object", "description": "Sub total amount for the transaction. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "nullable": true, "required": [ "amount", "currency" ], "example": { "amount": 2000, "currency": "CAD" } }, "subscription": { "title": "subscription", "type": "object", "properties": { "subscriptionId": { "$ref": "#/components/schemas/subscriptionId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "subscriptionType": { "$ref": "#/components/schemas/subscriptionType" }, "billingInformation": { "$ref": "#/components/schemas/billingInformation" }, "callbackUrl": { "$ref": "#/components/schemas/callbackUrl" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "subscriptionStatus": { "$ref": "#/components/schemas/subscriptionStatus" }, "oneTimeAmount": { "nullable": true, "description": "The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "credentialOnFileResponse": { "$ref": "#/components/schemas/credentialOnFileResponse" }, "customData": { "$ref": "#/components/schemas/customData" }, "payments": { "type": "array", "description": "List of payments", "items": { "$ref": "#/components/schemas/paymentReference" } } }, "required": [ "subscriptionId", "merchantId", "orderId", "createdAt", "subscriptionType", "billingInformation", "paymentMethod", "subscriptionStatus" ] }, "subscriptionId": { "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "description": "Unique Identification for the Subscription", "example": "si0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "subscriptionIntervalCount": { "type": "integer", "format": "int32", "description": "How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count.\n", "minimum": 1, "maximum": 99, "example": 12 }, "subscriptionList": { "title": "subscriptionList", "type": "object", "description": "Paginated List of subscriptions.", "properties": { "data": { "type": "array", "description": "List of subscriptions.", "items": { "type": "object", "$ref": "#/components/schemas/subscription" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "subscriptionPaymentMethodApplePayDecryptedWalletRequest": { "title": "subscriptionPaymentMethodApplePayDecryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/applePayDecryptedWallet" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodApplePayEncryptedWalletRequest": { "title": "subscriptionPaymentMethodApplePayEncryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/applePayEncryptedWallet" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodCardRequest": { "title": "subscriptionPaymentMethodCardRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodCard" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodGooglePayDecryptedWalletRequest": { "title": "subscriptionPaymentMethodGooglePayDecryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/googlePayDecryptedWallet" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodGooglePayEncryptedWalletRequest": { "title": "subscriptionPaymentMethodGooglePayEncryptedWalletRequest", "allOf": [ { "$ref": "#/components/schemas/googlePayEncryptedWallet" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodIdRequest": { "title": "subscriptionPaymentMethodIdRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodWithId" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionPaymentMethodPermanentTokenRequest": { "title": "subscriptionPaymentMethodPermanentTokenRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodPermanentToken" }, { "type": "object", "properties": { "credentialOnFileInformation": { "$ref": "#/components/schemas/credentialOnFileInformation" } }, "required": [ "credentialOnFileInformation" ] } ] }, "subscriptionPaymentMethodRequest": { "title": "subscriptionPaymentMethodRequest", "description": "Subscription Payment method details.\n\nNote: If defined, this will result in the creation of a Permanent Payment Method as defined in the Payment Method API.\n", "oneOf": [ { "$ref": "#/components/schemas/subscriptionPaymentMethodIdRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodCardRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodTemporaryTokenRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodPermanentTokenRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodApplePayEncryptedWalletRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodApplePayDecryptedWalletRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodGooglePayEncryptedWalletRequest" }, { "$ref": "#/components/schemas/subscriptionPaymentMethodGooglePayDecryptedWalletRequest" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "PAYMENT_METHOD_ID": "#/components/schemas/subscriptionPaymentMethodIdRequest", "CARD": "#/components/schemas/subscriptionPaymentMethodCardRequest", "TEMPORARY_TOKEN": "#/components/schemas/subscriptionPaymentMethodTemporaryTokenRequest", "PERMANENT_TOKEN": "#/components/schemas/subscriptionPaymentMethodPermanentTokenRequest", "APPLE_PAY_ENCRYPTED": "#/components/schemas/subscriptionPaymentMethodApplePayEncryptedWalletRequest", "APPLE_PAY_DECRYPTED": "#/components/schemas/subscriptionPaymentMethodApplePayDecryptedWalletRequest", "GOOGLE_PAY_ENCRYPTED": "#/components/schemas/subscriptionPaymentMethodGooglePayEncryptedWalletRequest", "GOOGLE_PAY_DECRYPTED": "#/components/schemas/subscriptionPaymentMethodGooglePayDecryptedWalletRequest" } } }, "subscriptionPaymentMethodTemporaryTokenRequest": { "title": "subscriptionPaymentMethodTemporaryTokenRequest", "allOf": [ { "$ref": "#/components/schemas/paymentMethodTemporaryToken" }, { "type": "object", "properties": { "credentialOnFileInformation": { "nullable": true, "type": "object", "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" }, "originalAmount": { "$ref": "#/components/schemas/originalAmount" } }, "required": [ "paymentIndicator", "paymentInformation" ], "example": { "paymentIndicator": "CUSTOMER_INITIATED", "paymentInformation": "FIRST", "issuerId": "123asd" } } } } ] }, "subscriptionReference": { "description": "Subscription reference, if this transaction is related to a subscription. \n", "type": "object", "nullable": true, "properties": { "subscriptionId": { "$ref": "#/components/schemas/subscriptionId" }, "href": { "nullable": true, "title": "SubscriptionUri", "description": "Subscription Reference URL", "type": "string", "format": "uri-reference", "example": "/subscriptions/rp0105ARZ3NDEKTSV4RRFFQ69G5FAV" } }, "required": [ "subscriptionId" ] }, "subscriptionStatus": { "type": "string", "description": "Subscription Status description.", "enum": [ "DECLINED", "DECLINED_RETRY", "PAUSED", "ACTIVE", "CANCELED", "COMPLETED" ], "example": "ACTIVE" }, "subscriptionType": { "type": "string", "description": "Subscription Type.\n- RECURRING: Recurring Subscription.\n", "enum": [ "RECURRING" ], "example": "RECURRING" }, "supplies": { "type": "array", "description": "A list of supply items.", "items": { "$ref": "#/components/schemas/supply" }, "maxItems": 116 }, "supply": { "type": "object", "description": "An object containing all details related to a supply.", "required": [ "supplyName", "unitPrice" ], "properties": { "supplyName": { "$ref": "#/components/schemas/supplyName" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "quantity": { "$ref": "#/components/schemas/quantity" } } }, "supplyName": { "type": "string", "description": "Indicates the name of the good available for fulfillment or distribution.", "maxLength": 100, "example": "2-PLY Sales Draft Slips (25)" }, "supplyType": { "type": "string", "description": "The type of supply associated with the device.", "nullable": true }, "surChargePaymentMethodRequest": { "title": "surchargePaymentMethodRequest", "description": "surcharge payment Method details.\nNote: If defined, this will result in the creation of a Permanent Payment Method as defined in the Payment Method API.\n", "oneOf": [ { "$ref": "#/components/schemas/paymentMethodWithId" }, { "$ref": "#/components/schemas/paymentMethodCard" }, { "$ref": "#/components/schemas/paymentMethodTemporaryToken" }, { "$ref": "#/components/schemas/paymentMethodPermanentToken" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "PAYMENT_METHOD_ID": "#/components/schemas/paymentMethodWithId", "CARD": "#/components/schemas/paymentMethodCard", "TEMPORARY_TOKEN": "#/components/schemas/paymentMethodTemporaryToken", "PERMANENT_TOKEN": "#/components/schemas/paymentMethodPermanentToken" } } }, "tax": { "type": "object", "description": "An object that contains information about the tax applied to an order fee.", "properties": { "taxName": { "type": "string", "description": "The name of the tax applied to the fee.", "enum": [ "GOODS_SERVICES_TAX", "PROVINCIAL_SALES_TAX", "HARMONIZED_SALES_TAX" ] }, "taxAmount": { "$ref": "#/components/schemas/money" } }, "required": [ "taxName", "taxAmount" ] }, "terminal": { "type": "object", "description": "An object representing a payment terminal device to process transactions.", "required": [ "terminalName" ], "properties": { "carrier": { "$ref": "#/components/schemas/terminalCarrier" }, "terminalName": { "$ref": "#/components/schemas/terminalName" }, "software": { "$ref": "#/components/schemas/software" }, "pinpadModel": { "$ref": "#/components/schemas/pinpadModel" }, "unitPrice": { "description": "The cost of a single unit of the terminal device.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "quantity": { "type": "integer", "description": "The number of terminal units being purchased or assigned.", "format": "int32", "example": 4 }, "cableType": { "$ref": "#/components/schemas/cableType" }, "pinpadCableType": { "$ref": "#/components/schemas/pinpadCableType" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" }, "pointOfSaleType": { "$ref": "#/components/schemas/pointOfSaleType" }, "transferDeviceReference": { "$ref": "#/components/schemas/transferDeviceReference" }, "kioskReference": { "$ref": "#/components/schemas/kioskReference" }, "kioskUnitPrice": { "description": "The cost of a single kiosk unit.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "manufacturer": { "$ref": "#/components/schemas/manufacturer" }, "installationType": { "$ref": "#/components/schemas/installationType" } } }, "terminalCarrier": { "type": "string", "description": "The name of the mobile network operator or service provider.", "example": "Telus", "maxLength": 255, "nullable": true }, "terminalName": { "type": "string", "description": "The name of the terminal.", "example": "Moneris Go", "maxLength": 255 }, "thirdPartyGiftCardFeeDetails": { "type": "object", "description": "An object representing the fees associated with third-party gift cards.", "nullable": true, "properties": { "programMonthlyFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "perTransactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "threeDSecureAuthentication": { "title": "authenticationResponse", "type": "object", "properties": { "threeDSecureAuthenticationId": { "$ref": "#/components/schemas/resourceId" }, "cardLookupId": { "nullable": true, "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" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "threeDSecureMessageType": { "$ref": "#/components/schemas/threeDSecureMessageType" }, "threeDSecureTransactionStatus": { "$ref": "#/components/schemas/threeDSecureTransactionStatus" }, "threeDSecureTransactionStatusReason": { "$ref": "#/components/schemas/threeDSecureTransactionStatusReason" }, "ecommerceIndicator": { "$ref": "#/components/schemas/ecommerceIndicator" }, "threeDSecureChallengeUrl": { "$ref": "#/components/schemas/threeDSecureChallengeUrl" }, "threeDSecureChallengeData": { "$ref": "#/components/schemas/threeDSecureChallengeData" }, "threeDSecureAuthenticationValue": { "$ref": "#/components/schemas/threeDSecureAuthenticationValue" }, "threeDSecureChallengeCompletionIndicator": { "$ref": "#/components/schemas/threeDSecureChallengeCompletionIndicator" }, "threeDSecureServerTransactionId": { "nullable": true, "type": "string", "description": "Indicates information required when sending a version 3-D Secure 2.0+ transaction. \n\nThis data is obtained from a CAVV Lookup Request or MPI 3DS Authentication Request transaction.\n", "format": "uuid", "example": "ad9b0eda-bf9b-4288-b188-9467993603e1" }, "threeDSecureDirectoryServerTransactionId": { "nullable": true, "type": "string", "description": "Universally unique transaction identifier assigned by the 3DS Directory Server (DS) to identify a single transaction.", "format": "uuid", "example": "ad9b0eda-bf9b-4288-b188-9467993603e1" }, "threeDSecureAccessControlServerTransactionId": { "nullable": true, "type": "string", "description": "Required if sending a version 3-D Secure 2.0+ transaction. Data is obtained from a Cavv Lookup Request or MPI 3DS Authentication Request transaction", "format": "uuid", "example": "ad9b0eda-bf9b-4288-b188-9467993603e1" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "threeDSecureCardholderInformation": { "$ref": "#/components/schemas/threeDSecureCardholderInformation" }, "threeDSecureVersion": { "$ref": "#/components/schemas/threeDSecureVersion" }, "threeDSecureAuthenticationType": { "$ref": "#/components/schemas/threeDSecureAuthenticationType" }, "threeDSecureAuthenticationTimestamp": { "$ref": "#/components/schemas/threeDSecureAuthenticationTimestamp" } }, "required": [ "threeDSecureAuthenticationId", "merchantId", "threeDSecureTransactionStatus", "ecommerceIndicator", "paymentMethod", "threeDSecureVersion" ] }, "threeDSecureAuthenticationBillingAddress": { "type": "object", "title": "threeDSecureAuthenticationRequestBillingAddress", "description": "The postal address including street, town/city, province, and postal code.", "properties": { "unitNumber": { "nullable": true, "type": "string", "description": "Unit number", "minLength": 1, "maxLength": 19, "example": "123A" }, "streetNumber": { "$ref": "#/components/schemas/streetNumber" }, "streetName": { "$ref": "#/components/schemas/streetName" }, "city": { "$ref": "#/components/schemas/city" }, "province": { "$ref": "#/components/schemas/province" }, "postalCode": { "$ref": "#/components/schemas/postalCode" }, "country": { "$ref": "#/components/schemas/country" } }, "example": { "unitNumber": "123A", "streetNumber": "3300", "streetName": "Bloor Street West", "city": "Toronto", "province": "ON", "postalCode": "M8X 2X2", "country": "CA" }, "required": [ "streetNumber", "streetName", "city", "province", "postalCode", "country" ] }, "threeDSecureAuthenticationTimestamp": { "type": "string", "description": "Date and time in UTC of the cardholder authentication.", "format": "date-time", "example": "2019-07-30T06:43:40.252Z", "nullable": true }, "threeDSecureAuthenticationType": { "type": "string", "nullable": true, "description": "Indicates the type of authentication method the Issuer will use to challenge the Cardholder, whether in the ARes message or what was used by the ACS when in the RReq message.", "enum": [ "STATIC", "DYNAMIC", "OUT_OF_BAND", "DECOUPLED", null ], "example": "DYNAMIC" }, "threeDSecureAuthenticationValue": { "type": "string", "description": "**CAVV**: Cardholder Authentication Verification Value\nProvided during a payment request to authenticate the card user.\n", "maxLength": 50, "example": "00000109260000719349", "nullable": true }, "threeDSecureAuthenticationValueResult": { "type": "string", "nullable": true, "description": "The Cardholder Authentication Verification Value (CAVV), the Account holder Authentication Value (AAV), and the American Express Verification Value (AEVV), are the values that allows Visa, Mastercard and American Express to validate the integrity of the Visa Secure, Mastercard Identity Check and American Express SafeKey transaction data. These values are passed back from the issuer to the merchant after the authentication has taken place. The merchant then integrates the CAVV/AAV/AEVV value into the authorization request using the Payment request with 3-D Secure transaction data.\n", "enum": [ "AMEX_AEVV_FAILED_ATTEMPT_ISSUER_KEY", "AMEX_AEVV_FAILED_ATTEMPT_ISSUER_NOT_PARTICIPATING_NETWORK_KEY", "AMEX_AEVV_FAILED_ATTEMPT_PARTICIPATING_NOT_AVAILABLE_NETWORK_KEY", "AMEX_AEVV_FAILED_AUTHENTICATION_ISSUER_KEY", "AMEX_AEVV_PASSED_ATTEMPT_ISSUER_KEY", "AMEX_AEVV_PASSED_ATTEMPT_ISSUER_NOT_PARTICIPATING_NETWORK_KEY", "AMEX_AEVV_PASSED_ATTEMPT_PARTICIPATING_NOT_AVAILABLE_NETWORK_KEY", "AMEX_AEVV_PASSED_AUTHENTICATION_ISSUER_KEY", "AMEX_AEVV_UNCHECKED", "VISA_CAVV_NOT_PRESENT_OR_NOT_VERIFIED", "MASTERCARD_AUTHENTICATION_ATTEMPTED", "MASTERCARD_AUTHENTICATION_FAILED", "MASTERCARD_AUTHENTICATION_SUCCESSFUL", "VISA_CAVV_AUTHENTICATION_RESULTS_INVALID", "VISA_CAVV_FAILED_VALIDATION_ATTEMPTED", "VISA_CAVV_FAILED_VALIDATION_AUTHENTICATION", "VISA_CAVV_NOT_VALIDATED_ISSUER_NOT_PARTICIPATING", "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED", "VISA_CAVV_PASSED_VALIDATION_AUTHENTICATION", "VISA_CAVV_PASSED_VALIDATION_INFO_ONLY", "VISA_CAVV_WAS_NOT_VALIDATED_ATTEMPTED", "VISA_CAVV_WAS_NOT_VALIDATED_AUTHENTICATION", null ], "example": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "threeDSecureCardholderInformation": { "nullable": true, "type": "string", "description": "Text provided by the ACS/Issuer to Cardholder during a Frictionless or Decoupled transaction. The Issuer can provide information to Cardholder.", "maxLength": 128, "example": "Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx." }, "threeDSecureChallengeCompletionIndicator": { "type": "string", "nullable": true, "description": "Indicates if Challenge was completed. This is returned in CAVV Lookup Request.\n", "enum": [ "YES", "NO", null ] }, "threeDSecureChallengeData": { "type": "string", "description": "String that must be POSTed to the Challenge URL to create challenge screen", "minLength": 1, "maxLength": 2048, "nullable": true }, "threeDSecureChallengeRequested": { "type": "string", "description": "Indicates whether a browser-based challenge is requested for this transaction. Standard is 'No Preference'", "enum": [ "NO_PREFERENCE", "NO_CHALLENGE_REQUESTED", "CHALLENGE_REQUESTED_MANDATE", null ], "example": "NO_PREFERENCE", "nullable": true, "default": "NO_PREFERENCE" }, "threeDSecureChallengeResponseData": { "type": "string", "description": "Provides the response data from the challenge.", "example": "TBD" }, "threeDSecureChallengeUrl": { "type": "string", "description": "If the transStatus is “C” this field will be populated with the URL to POST the challengeData to create the cardholder challenge screen", "format": "uri", "minLength": 1, "maxLength": 2048, "example": "https://developer.moneris.com/", "nullable": true }, "threeDSecureChallengeWindowSize": { "type": "string", "description": "Relates to the rendering of the challenge within the browser.\n - **X_SMALL**: 250 x 400\n - **SMALL**: 390 x 400\n - **MEDIUM**: 500 x 600\n - **LARGE**: 600 x 400\n - **FULL_SCREEN**: Full Screen\n", "enum": [ "X_SMALL", "SMALL", "MEDIUM", "LARGE", "FULL_SCREEN", null ], "example": "FULL_SCREEN", "nullable": true }, "threeDSecureCompletionIndicator": { "type": "string", "description": "Indicates whether 3DS Card Lookup was successfully completed. A successful Card Lookup increases the chances of a frictionless card authentication.\n - **SUCCESS**: Successfully completed.\n - **FAILURE**: 3DS Card Lookup attempted, but failed.\n - **UNAVAILABLE**: Unavailable or not attempted.\n", "enum": [ "SUCCESS", "FAILURE", "UNAVAILABLE", null ], "example": "SUCCESS", "nullable": true }, "threeDSecureData": { "description": "Data related to 3-D Secure", "type": "object", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/threeDSecureWithAuthenticationId" }, { "$ref": "#/components/schemas/threeDSecureWithAuthenticationData" } ] }, "threeDSecureDeviceChannel": { "type": "string", "description": "Indicates the type of channel interface being used to initiate the transaction.", "enum": [ "BROWSER", "THREE_D_SECURE_REQUESTOR_INITIATED" ], "example": "BROWSER" }, "threeDSecureDirectoryServerTransactionId": { "type": "string", "description": "Universally unique transaction identifier assigned by the 3DS Directory Server (DS) to identify a single transaction.", "format": "uuid", "example": "ad9b0eda-bf9b-4288-b188-9467993603e1" }, "threeDSecureMessageCategory": { "type": "string", "description": "Identifies the category of the message for a specific use case.", "enum": [ "PAYMENT", "NON_PAYMENT" ], "example": "PAYMENT" }, "threeDSecureMessageType": { "type": "string", "description": "Indicates the response type in 3DS flow.", "nullable": true, "enum": [ "AUTHENTICATION_RESPONSE_MESSAGE", "AUTHENTICATION_REQUEST_MESSAGE", "PREPARATION_RESPONSE_MESSAGE", "PREPARATION_REQUEST_MESSAGE", "CHALLENGE_RESPONSE_MESSAGE", "CHALLENGE_REQUEST_MESSAGE", "RESULTS_REQUEST_MESSAGE", "RESULTS_RESPONSE_MESSAGE", "ERROR_MESSAGE", null ], "example": "CHALLENGE_RESPONSE_MESSAGE" }, "threeDSecureMethodData": { "type": "string", "description": "Data that must be posted to 3DS Method URL for the Device Fingerprinting step.", "minLength": 1, "maxLength": 254 }, "threeDSecureMethodUrl": { "type": "string", "format": "uri", "description": "Returns the URL for the Device Fingerprinting step.", "minLength": 1, "maxLength": 256, "example": "https://developer.moneris.com/" }, "threeDSecureNotificationUrl": { "type": "string", "description": "URL-encoded, fully qualified callback URL that receives the response or error message. \n\nNote: Request with URL that is not URL-encoded will be rejected for security reasons.\n\nExample (URL-encoded): https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123\n", "minLength": 1, "maxLength": 256, "example": "https%3A%2F%2Fdeveloper.moneris.com%2F" }, "threeDSecurePriorAuthenticationData": { "type": "string", "description": "Data that documents and supports a specific authentication process. In the current version of the specification this data element is not defined in detail, however the intention is that for each 3DS Requestor Authentication Method, this field carry data that the ACS can use to verify the authentication process. In future versions of the specification, these details are expected to be included.", "maxLength": 2048, "example": "12345678", "nullable": true }, "threeDSecurePriorAuthenticationInformation": { "type": "object", "description": "Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.", "nullable": true, "properties": { "threeDSecurePriorAuthenticationData": { "$ref": "#/components/schemas/threeDSecurePriorAuthenticationData" }, "threeDSecurePriorAuthenticationMethod": { "$ref": "#/components/schemas/threeDSecurePriorAuthenticationMethod" }, "threeDSecurePriorAuthenticationTimestamp": { "$ref": "#/components/schemas/threeDSecurePriorAuthenticationTimestamp" }, "threeDSecurePriorAuthenticationReference": { "$ref": "#/components/schemas/threeDSecurePriorAuthenticationReference" } } }, "threeDSecurePriorAuthenticationMethod": { "type": "string", "description": "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.", "enum": [ "FRICTIONLESS_AUTHENTICATION_OCCURRED_BY_ACS", "CARDHOLDER_CHALLENGE_OCCURRED_BY_ACS", "AVS_VERIFIED", "OTHER_ISSUER_METHODS", null ], "example": "AVS_VERIFIED", "nullable": true }, "threeDSecurePriorAuthenticationReference": { "type": "string", "description": "This data element provides additional information to the ACS to determine the best approach for handing a request.", "maxLength": 36, "example": "12345678", "nullable": true }, "threeDSecurePriorAuthenticationTimestamp": { "type": "string", "description": "Date and time in UTC of the prior cardholder authentication.", "format": "date-time", "example": "2019-07-30T06:43:40.252Z", "nullable": true }, "threeDSecureRecurringExpiry": { "type": "string", "description": "Date after which no further authorisations shall be performed. This is a required field for recurring transactions, we suggest setting it at a reasonably high value if you don't have a defined expiry date.", "format": "date", "example": "2019-07-30", "nullable": true }, "threeDSecureRecurringFrequency": { "type": "integer", "format": "int32", "description": "Indicates the minimum number of days between authorisations.", "minimum": 1, "maximum": 9999, "example": 1, "nullable": true }, "threeDSecureRequestType": { "type": "string", "nullable": true, "description": "Type of payment that triggered the verification.\n - **CARDHOLDER**: Cardholder initiated payment.\n - **RECURRING**: Recurring payment.\n", "enum": [ "CARDHOLDER", "RECURRING", null ], "example": "CARDHOLDER" }, "threeDSecureRequestorInitiatedIndicator": { "type": "string", "description": "Indicates the type of 3RI request. This data element provides additional information to the ACS to determine the best approach for handing a 3RI request.", "enum": [ "RECURRING_TRANSACTION", "INSTALMENT_TRANSACTION", "ADD_CARD", "MAINTAIN_CARD_INFORMATION", "ACCOUNT_VERIFICATION", "SPLIT_DELAYED_SHIPMENT", "TOP_UP", "MAIL_ORDER", "TELEPHONE_ORDER", "WHITELIST_STATUS_CHECK", "OTHER_PAYMENT", null ], "example": "RECURRING_TRANSACTION", "nullable": true }, "threeDSecureServerTransactionId": { "type": "string", "description": "Indicates information required when sending a version 3-D Secure 2.0+ transaction. \n\nThis data is obtained from a CAVV Lookup Request or MPI 3DS Authentication Request transaction.\n", "format": "uuid", "example": "ad9b0eda-bf9b-4288-b188-9467993603e1" }, "threeDSecureTransactionStatus": { "type": "string", "description": "Indicates the Transaction result. For more information about this field, please review https://docs.3dsecure.io/3dsv2/specification_220.html#attr-ARes-transStatus\n - **AUTHENTICATED**: Authentication/ Account Verification Successful.\n - **AUTHENTICATION_ATTEMPTED**: Attempts Processing Performed; Not Authenticated/Verified , but a proof of attempted authentication/verification is provided.\n - **CHALLENGE_AUTHENTICATION_REQUIRED**: Challenge Required; Additional authentication is required using the `challengeUrl` and `challengeData`.\n - **CHALLENGE_DECOUPLED_AUTHENTICATION_CONFIRMED**: Challenge Required; Decoupled Authentication confirmed. \n - **TECHNICAL_ISSUE**: Authentication/ Account Verification Could Not Be Performed; Technical or other problem.\n - **NOT_AUTHENTICATED**: Not Authenticated /Account Not Verified; Transaction denied.\n - **REJECTED**: Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.\n - **CHALLENGE_PREFERENCE_ACKNOWLEDGED**: Informational Only; 3DS Requestor challenge preference acknowledged.\n", "enum": [ "AUTHENTICATED", "AUTHENTICATION_ATTEMPTED", "CHALLENGE_AUTHENTICATION_REQUIRED", "CHALLENGE_DECOUPLED_AUTHENTICATION_CONFIRMED", "TECHNICAL_ISSUE", "NOT_AUTHENTICATED", "REJECTED", "CHALLENGE_PREFERENCE_ACKNOWLEDGED" ] }, "threeDSecureTransactionStatusReason": { "type": "string", "nullable": true, "description": "Provides information on why the Transaction Status field has the specified value.\n", "example": "01 - Card authentication failed" }, "threeDSecureVersion": { "type": "string", "description": "Required when sending a 3-D Secure version 2.0+ transaction. If no value is provided, default to V1.", "maxLength": 10, "example": "2.2" }, "threeDSecureWithAuthenticationData": { "type": "object", "title": "Three DS Authentication Data", "properties": { "threeDSecureAuthenticationValue": { "$ref": "#/components/schemas/threeDSecureAuthenticationValue" }, "threeDSecureVersion": { "$ref": "#/components/schemas/threeDSecureVersion" }, "threeDSecureServerTransactionId": { "$ref": "#/components/schemas/threeDSecureServerTransactionId" }, "threeDSecureDirectoryServerTransactionId": { "$ref": "#/components/schemas/threeDSecureDirectoryServerTransactionId" } }, "required": [ "threeDSecureAuthenticationValue", "threeDSecureVersion", "threeDSecureServerTransactionId", "threeDSecureDirectoryServerTransactionId" ] }, "threeDSecureWithAuthenticationId": { "title": "Three DS Authentication Id", "type": "object", "properties": { "threeDSecureAuthenticationId": { "$ref": "#/components/schemas/resourceId" } }, "required": [ "threeDSecureAuthenticationId" ] }, "tipAmount": { "type": "object", "description": "Total tip amount for the transaction. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "nullable": true, "example": { "amount": 1200, "currency": "CAD" } }, "token": { "type": "string", "description": "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.", "minLength": 25, "maxLength": 28, "example": "ot-HCUeCFtXJfEZSSUqvUJkS0" }, "transactionDateTime": { "description": "Indicates the date and time of the transaction.", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "transactionFeeParameterCode": { "type": "string", "description": "The code that identifies the parameters associated with transaction fees for a specific card plan.", "nullable": true, "maxLength": 20, "enum": [ "ATIP", "INDI", "KATZ", "INTP", "MCR3", "PLQ2", "SHOP", "CF02", "INGB", "Q200", "PLQ1", "VISA", "GNDS", "TXLP", "FLAT", "INDG", "CFIB", "SER4", "SER3", "TIRR", "TR00", "DIEN", "AMZN", "CF01", "TR02", "MCR1", "ID58", "INDN", "SDMI", "SEAR", "CRAV", "CITI", "CDMV", "CTP2", "SIMS", "DOLA", "PAYM", "ROGE", "CTP1", "GOVC", "PREC", "CITB", "ID53", "SIMP", "COST", "TTMK", "SER1" ] }, "transactionPlan": { "type": "object", "description": "An object containing the transaction plan details.", "properties": { "merchantDiscountRate": { "$ref": "#/components/schemas/merchantDiscountRate" }, "minimumMerchantDiscountRate": { "$ref": "#/components/schemas/minimumMerchantDiscountRate" }, "maximumMerchantDiscountRate": { "$ref": "#/components/schemas/maximumMerchantDiscountRate" }, "transactionRate": { "$ref": "#/components/schemas/transactionRate" }, "minimumTransactionValue": { "description": "The minimum transaction value that applies under the transaction plan.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "maximumTransactionValue": { "description": "The maximum transaction value that applies under the transaction plan.", "nullable": true, "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "disqualifiedTransactionMerchantDiscountRate": { "$ref": "#/components/schemas/disqualifiedTransactionMerchantDiscountRate" }, "transactionPlanTier": { "$ref": "#/components/schemas/transactionPlanTier" }, "feeTypeCode": { "$ref": "#/components/schemas/feeTypeCode" }, "paymentModeCode": { "$ref": "#/components/schemas/paymentModeCode" }, "minimumDisqualifiedTransactionMerchantDiscountRate": { "$ref": "#/components/schemas/minimumDisqualifiedTransactionMerchantDiscountRate" }, "maximumDisqualifiedTransactionMerchantDiscountRate": { "$ref": "#/components/schemas/maximumDisqualifiedTransactionMerchantDiscountRate" } } }, "transactionPlanTier": { "type": "string", "description": "The level or band within the transaction plan.", "nullable": true, "maxLength": 10 }, "transactionPlans": { "type": "array", "description": "A list of transaction items.", "items": { "$ref": "#/components/schemas/transactionPlan" }, "maxItems": 20 }, "transactionRate": { "type": "number", "description": "The single payment processing event under the transaction plan.", "default": 0, "format": "double", "minimum": 0, "maximum": 1 }, "transferDeviceReference": { "type": "string", "description": "Indicates the identifier of the device being transferred as part of the current terminal request.", "nullable": true, "maxLength": 50 }, "transitNumber": { "type": "string", "description": "Attribute representing the five-digit branch number of a financial institution.", "nullable": true, "maxLength": 10 }, "ueat": { "type": "object", "description": "An object containing details about the Ueat product.", "nullable": true, "properties": { "plannedGoLiveDate": { "type": "string", "description": "The planned go-live date for the Ueat product.", "format": "date", "example": "2010-02-21", "nullable": true }, "numberOfMenuItems": { "type": "integer", "description": "The number of menu items available in the Ueat product.", "format": "int32", "minimum": 1, "maximum": 10000 }, "isMemberOfArq": { "type": "boolean", "description": "A boolean flag indicating whether the Ueat product is a member of the ARQ program." }, "averageAmountSpent": { "nullable": true, "type": "object", "description": "Monetary amount. \nNote: The value must be in cents. Therefore $10.59 must be sent as 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "pointOfSaleSystemName": { "type": "string", "description": "The name of the point of sale system used with the Ueat product.", "maxLength": 100, "nullable": true }, "feeDetails": { "type": "object", "nullable": true, "description": "An object representing the fees associated with the Ueat product.", "properties": { "implementationFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "additionalBoutiqueFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "additionalBoutiqueOneTimeFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "mobileAppFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "mobileAppOneTimeFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "webCreationAndHostingFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "webCreationAndHostingOneTimeFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "payAtRestaurantPerTransactionFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "payAtRestaurantFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "oneTimeTaxFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "isLiveIn30": { "type": "boolean", "description": "A boolean flag indicating whether the Ueat product is live in 30 days." }, "additionalNote": { "type": "string", "description": "Additional note or comments related to the Ueat product.", "maxLength": 500, "nullable": true }, "additionalLocations": { "type": "array", "maxItems": 10, "description": "A list of additional locations associated with the Ueat product.", "items": { "$ref": "#/components/schemas/address" } } } }, "unionPayTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through UnionPay payments.", "format": "int32", "example": 1000 }, "updateOrderRequest": { "description": "Represents the payload for updating an order.", "oneOf": [ { "$ref": "#/components/schemas/updateStandardOrderRequest" }, { "$ref": "#/components/schemas/updatePartnerBankOrderRequest" } ] }, "updatePartnerBankOrderRequest": { "type": "object", "description": "An object containing all the Order payload partner bank details.", "properties": { "solutions": { "$ref": "#/components/schemas/solutions" }, "deliveryAddress": { "type": "object", "nullable": true, "description": "An object containing the delivery address details.", "allOf": [ { "$ref": "#/components/schemas/address" }, { "$ref": "#/components/schemas/addressee" } ] }, "bankerInformation": { "$ref": "#/components/schemas/bankerInformation" }, "orderCreatedBy": { "$ref": "#/components/schemas/orderCreatedBy" } }, "required": [ "solutions", "deliveryAddress", "bankerInformation" ] }, "updatePaymentMethodRequest": { "title": "updatePaymentMethodRequest", "oneOf": [ { "$ref": "#/components/schemas/paymentMethodCard" }, { "$ref": "#/components/schemas/paymentMethodTemporaryToken" }, { "$ref": "#/components/schemas/paymentMethodPermanentToken" }, { "$ref": "#/components/schemas/applePayEncryptedWallet" }, { "$ref": "#/components/schemas/applePayDecryptedWallet" }, { "$ref": "#/components/schemas/googlePayEncryptedWallet" }, { "$ref": "#/components/schemas/googlePayDecryptedWallet" } ], "discriminator": { "propertyName": "paymentMethodSource", "mapping": { "CARD": "#/components/schemas/paymentMethodCard", "TEMPORARY_TOKEN": "#/components/schemas/paymentMethodTemporaryToken", "PERMANENT_TOKEN": "#/components/schemas/paymentMethodPermanentToken", "APPLE_PAY_ENCRYPTED": "#/components/schemas/applePayEncryptedWallet", "APPLE_PAY_DECRYPTED": "#/components/schemas/applePayDecryptedWallet", "GOOGLE_PAY_ENCRYPTED": "#/components/schemas/googlePayEncryptedWallet", "GOOGLE_PAY_DECRYPTED": "#/components/schemas/googlePayDecryptedWallet" } }, "required": [ "paymentMethodSource" ] }, "updateStandardOrderRequest": { "type": "object", "description": "Represents the payload for updating an order.", "properties": { "marketSegment": { "$ref": "#/components/schemas/marketSegment" }, "representativeCode": { "$ref": "#/components/schemas/representativeCode" }, "userDetails": { "$ref": "#/components/schemas/userDetails" }, "applicablePromotions": { "$ref": "#/components/schemas/applicablePromotions" }, "feeDetails": { "$ref": "#/components/schemas/feeDetails" }, "applicationDetails": { "$ref": "#/components/schemas/applicationDetails" }, "agreementModelInformation": { "$ref": "#/components/schemas/agreementModelInformation" }, "valueAddedServices": { "$ref": "#/components/schemas/valueAddedServices" }, "documentsStatus": { "$ref": "#/components/schemas/documentsStatus" }, "confirmation": { "$ref": "#/components/schemas/confirmation" }, "supplies": { "$ref": "#/components/schemas/supplies" }, "productDetails": { "$ref": "#/components/schemas/productDetails" }, "isAutoAdjudicationRequired": { "$ref": "#/components/schemas/isAutoAdjudicationRequired" }, "isExpeditedOrder": { "$ref": "#/components/schemas/isExpeditedOrder" }, "cardPlanDetails": { "nullable": true, "type": "object", "description": "An object containing all the card plans details.", "properties": { "merchantDiscountRateType": { "$ref": "#/components/schemas/merchantDiscountRateType" }, "currency": { "nullable": true, "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" }, "transactionFeeParameterCode": { "$ref": "#/components/schemas/transactionFeeParameterCode" }, "cardBrandTemplateIdentifier": { "$ref": "#/components/schemas/cardBrandTemplateIdentifier" }, "selectedPlans": { "$ref": "#/components/schemas/selectedPlans" }, "mastercard": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "mastercardDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visa": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "visaDebit": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "discover": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "unionPay": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "interac": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "amex": { "nullable": true, "type": "object", "description": "An object containing the franchise plan details.", "properties": { "isCommunicationsOptOut": { "$ref": "#/components/schemas/isCommunicationsOptOut" }, "cardFeeDetails": { "$ref": "#/components/schemas/cardFeeDetails" }, "transactionPlans": { "$ref": "#/components/schemas/transactionPlans" }, "cardBrandPlans": { "$ref": "#/components/schemas/cardBrandPlans" }, "assessmentPlans": { "$ref": "#/components/schemas/assessmentPlans" }, "serviceFeeDetails": { "$ref": "#/components/schemas/serviceFeeDetails" } } }, "otherFinancialInstitutionCards": { "$ref": "#/components/schemas/otherFinancialInstitutionCards" }, "programs": { "$ref": "#/components/schemas/programs" } } }, "solutions": { "$ref": "#/components/schemas/solutions" }, "deliveryAddress": { "type": "object", "nullable": true, "description": "An object containing the delivery address details.", "allOf": [ { "$ref": "#/components/schemas/address" }, { "$ref": "#/components/schemas/addressee" } ] }, "orderCreatedBy": { "$ref": "#/components/schemas/orderCreatedBy" } }, "required": [ "userDetails", "productDetails" ] }, "updateSubscriptionDetails": { "type": "object", "description": "Update Subscription details such as the subscription billing cycle, amount, and payment method.", "properties": { "paymentMethod": { "$ref": "#/components/schemas/subscriptionPaymentMethodIdRequest" }, "totalSubscriptionIntervalCount": { "$ref": "#/components/schemas/subscriptionIntervalCount" }, "subscriptionAmount": { "description": "The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "callbackUrl": { "$ref": "#/components/schemas/callbackUrl" }, "customerId": { "$ref": "#/components/schemas/customerId" }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "customData": { "$ref": "#/components/schemas/customData" } } }, "uploadImagesRequest": { "description": "Information of files.", "type": "object", "properties": { "files": { "description": "Array of file objects.", "type": "array", "maxItems": 5, "items": { "type": "string", "format": "binary" } } } }, "uploadStatus": { "description": "Response for status check endpoint call.", "type": "object", "required": [ "uploadReferenceId", "uploadStatus" ], "properties": { "uploadReferenceId": { "description": "Upload reference id.", "example": "IU1001ARZ3NDEKTSV4RRFFQ69G5FAV", "type": "string" }, "uploadStatus": { "type": "string", "description": "Status type. \n - `PENDING`: The Images have been pending upload. \n - `FAILED`: Image upload failed. Failure could be caused by different reasons.\n - `SUCCESSFUL`: Images uploaded successfully.\n", "enum": [ "PENDING", "FAILED", "SUCCESSFUL" ] } } }, "url": { "type": "string", "format": "uri", "description": "Provides the Uniform Resource Identifier based on the RFC 3986 standard.\n\nFor additional details, visit: https://www.rfc-editor.org/rfc/rfc3986.\n", "minLength": 1, "maxLength": 256, "example": "https://developer.moneris.com/" }, "userDetails": { "type": "object", "description": "An object containing personal information about the user involved in the transaction.", "properties": { "userIdentifier": { "$ref": "#/components/schemas/userIdentifier" }, "firstName": { "$ref": "#/components/schemas/firstName" }, "lastName": { "$ref": "#/components/schemas/lastName" } } }, "userIdentifier": { "type": "string", "description": "A unique identifier assigned to a user within the system.", "nullable": true, "maxLength": 30 }, "validation": { "title": "validation", "type": "object", "properties": { "validationId": { "description": "The unique identifier of the Validation", "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "validationStatus": { "$ref": "#/components/schemas/validationStatus" }, "transactionDetails": { "$ref": "#/components/schemas/statusDetails" }, "verificationDetails": { "$ref": "#/components/schemas/validationVerificationDetails" }, "credentialOnFileResponse": { "$ref": "#/components/schemas/credentialOnFileResponse" }, "customerId": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "validationId", "merchantId", "createdAt", "paymentMethod", "validationStatus", "transactionDetails", "verificationDetails" ] }, "validationList": { "title": "validationsList", "type": "object", "properties": { "data": { "description": "List of validations.", "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/validation" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "validationStatus": { "type": "string", "description": "Validation Status description.", "enum": [ "DECLINED", "DECLINED_RETRY", "PROCESSING", "SUCCEEDED" ], "example": "SUCCEEDED" }, "validationVerificationDetails": { "description": "CVD, AVS, 3DS, ITD Result Codes", "type": "object", "properties": { "addressVerificationServiceResultCode": { "$ref": "#/components/schemas/addressVerificationServiceResultCode" }, "cardSecurityCodeResultCode": { "$ref": "#/components/schemas/cardSecurityCodeResult" } } }, "valueAddedServices": { "type": "array", "description": "A list of value-added services associated with the order.", "maxItems": 18, "items": { "type": "string", "enum": [ "ABU", "BOOKMARK", "BOOKMARK_PRO", "DCC", "GIFT_CARD", "INSTALLMENTS", "INTERAC_ECOM", "INTERAC_ONLINE", "LOYALTY", "MCP", "MONERIS_ADVANCE", "P2PE", "PAYMENT_REQUEST", "SAF", "THIRD_PARTY_GIFT_CARD", "VAU", "WEB_CREATION_PACKAGES", "WIX" ] }, "uniqueItems": true }, "verificationDetails": { "description": "Result Codes for CVD, AVS, 3DS", "type": "object", "properties": { "addressVerificationServiceResultCode": { "$ref": "#/components/schemas/addressVerificationServiceResultCode" }, "cardSecurityCodeResultCode": { "$ref": "#/components/schemas/cardSecurityCodeResult" }, "threeDSecureAuthenticationValueResultCode": { "$ref": "#/components/schemas/threeDSecureAuthenticationValueResult" } } }, "visaDebitTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through Visa Debit payments.", "format": "int32", "example": 42 }, "visaTransactionVolume": { "type": "integer", "description": "A numeric value representing the total transaction volume generated through Visa payments.", "format": "int32" }, "waivePeriod": { "type": "string", "description": "Specifies the period which the fee is waived and not charged to the user.", "format": "period", "nullable": true, "example": "2022-06-30T14:52:44.276/PT48H", "maxLength": 34 }, "walletCryptogram": { "type": "string", "description": "Token cryptogram or encoded Base64 for Interac Wallets.", "maxLength": 500, "example": "8YGKgiD0iJic84fBLVj3QuwuclqLp7QvizbKnGRYAMVfVwBobYMBAIQBAIUBAIZTWgpQdgQQKZkZFHGfXySDKRAxXyoCASSfAgYAAAAQAABfIAIgL58ZBgSSSSSSSL9JIoEgAAMj1qj1U9jsORa1qxqAEAHOBAAEAECKALEAAAADEACHCAAAAAAAAAAAkAA=" }, "walletEcommerceIndicator": { "type": "string", "description": "ECI Indicator as provided by the Wallet.", "nullable": true }, "walletIndicator": { "type": "string", "description": "Only available to Canada integrations.\nApplies to merchants using their own API for transaction payload encryptions for Apple Pay and Google Pay transactions.\n**NOTE**: This field is mandatory for wallet transactions and is case senstive.\"\n", "enum": [ "IN_APPLICATION", "IN_BROWSER" ] }, "webCreationPackagesFeeDetails": { "type": "object", "description": "An object representing the fees associated with web creation packages.", "nullable": true, "properties": { "standardPlusFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "optionalServicesFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "websiteId": { "description": "Website identifier of where order originated", "type": "string", "maxLength": 8, "example": "DEFAULT" }, "wireless": { "type": "object", "description": "An object containing details about the wireless connectivity product.", "nullable": true, "properties": { "terminals": { "type": "array", "description": "A list of payment terminals available at the counter.", "items": { "$ref": "#/components/schemas/terminal" }, "maxItems": 21 }, "feeDetails": { "$ref": "#/components/schemas/wirelessFeeDetails" } } }, "wirelessFeeDetails": { "type": "object", "description": "A list of fees associated with the wireless product.", "nullable": true, "properties": { "activationFee": { "description": "A one-time fee charged for activating the wireless service.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] }, "goSoftwareFee": { "description": "A fee associated with the Moneris Go software for wireless devices.", "nullable": true, "type": "object", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "wixPointOfSale": { "type": "object", "description": "An object containing details about the Wix Point of Sale product.", "nullable": true, "properties": { "hasDevice": { "type": "boolean", "description": "A boolean flag indicating whether the Wix Point of Sale product includes a device." }, "lanesNumber": { "type": "integer", "description": "The number of lanes available for the Wix Point of Sale product.", "format": "int32", "minimum": 1, "maximum": 100 }, "wixJson": { "type": "string", "description": "A JSON string containing additional details about the Wix Point of Sale product.", "maxLength": 1000, "nullable": true }, "softwareAccessFee": { "nullable": true, "type": "object", "description": "Represents a monetary charge applied to a transaction or service.", "properties": { "feeType": { "$ref": "#/components/schemas/feeType" }, "unitPrice": { "$ref": "#/components/schemas/money" }, "taxes": { "type": "array", "description": "A list of tax items associated with the fee.", "items": { "$ref": "#/components/schemas/tax" }, "maxItems": 10 }, "frequency": { "description": "The frequency at which the fee is charged, such as monthly or annually.", "type": "string", "nullable": true, "maxLength": 20, "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ONE_OFF", "ANNUALLY" ] }, "quantity": { "type": "integer", "description": "Represent the number of times a fee is applied based on its frequency.", "format": "int32", "minimum": 1, "maximum": 30, "example": 3 }, "isApproved": { "$ref": "#/components/schemas/isApproved" }, "waivePeriod": { "$ref": "#/components/schemas/waivePeriod" } }, "required": [ "unitPrice" ] } } }, "yearsOfOwnership": { "type": "integer", "description": "An integer representing the number of years the merchant has been in ownership.", "format": "int32" } }, "parameters": { "acceptLanguage": { "in": "header", "name": "Accept-Language", "description": "This value indicates the natural language and locale that the client prefers\n", "required": true, "schema": { "type": "string" } }, "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" } }, "authenticationId": { "in": "path", "name": "authentication-id", "description": "The unique identifier of the authentication", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "caseId": { "name": "case-id", "in": "path", "description": "The case ID associated with the uploaded files.", "required": true, "example": "121719004438", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{12}$" } }, "caseRecNo": { "name": "case-record-number", "in": "path", "description": "The case record number of the files. This must be a value between \"0\" and \"99\".", "required": true, "example": "1", "schema": { "type": "integer", "minimum": 0, "maximum": 99 } }, "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" } }, "createdFrom": { "name": "created_from", "in": "query", "description": "Returns items created after the specified date, defaults to the current date starting from 12 AM.", "required": false, "example": "2024-05-16T04:00:00Z", "schema": { "$ref": "#/components/schemas/dateTime" } }, "createdTo": { "name": "created_to", "in": "query", "description": "Returns items created before the specified date, up to one day earlier. \n\nDefaults to current date and time, must be no more than 1 day later than `created_from` date. \n", "required": false, "example": "2024-05-16T04:00:00Z", "schema": { "$ref": "#/components/schemas/dateTime" } }, "customerId": { "in": "path", "name": "customer-id", "description": "The unique identifier of the customer", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "kountInquiryId": { "in": "path", "name": "kount-inquiry-id", "description": "The unique identifier of the Kount Transaction.", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "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" } }, "merchantOrderId": { "in": "path", "name": "merchant-order-id", "description": "The unique identifier of the merchant", "required": true, "schema": { "$ref": "#/components/schemas/merchantOrderId" } }, "multiCurrencyPricingRateLookupId": { "in": "path", "name": "multi-currency-pricing-rate-lookup-id", "description": "The unique identifier of the multiCurrencyPricing Rate Operation", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "pageBeforeCursor": { "in": "query", "name": "cursor", "description": "Pagination cursor to return items located after it.", "required": false, "example": "d41d8cd98f00b204e9800998ecf8427e", "schema": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } }, "pageLimit": { "in": "query", "name": "limit", "description": "Maximum number of items to return in the response.", "example": 10, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 20, "example": 10 } }, "paymentId": { "in": "path", "name": "payment-id", "description": "The unique identifier of the payment", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "paymentMethodId": { "name": "payment-method-id", "in": "path", "description": "Payment Method ID", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "prm-merchants_merchantId": { "in": "path", "name": "merchant-id", "example": "0123456789101", "required": true, "description": "Thirteen character identification code. \nNote: This code is provided by Moneris and is required to identify the Merchant executing the transaction.\"\n", "schema": { "$ref": "#/components/schemas/merchantId" } }, "refundId": { "in": "path", "name": "refund-id", "description": "The unique identifier of the refund", "required": true, "schema": { "$ref": "#/components/schemas/refundId" } }, "subscriptionId": { "in": "path", "name": "subscription-id", "description": "The unique identifier of the subscription", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } }, "uploadReferenceId": { "description": "Upload reference Id.", "example": "IU1001ARZ3NDEKTSV4RRFFQ69G5FAV", "in": "path", "name": "upload-reference-id", "required": true, "schema": { "type": "string" } }, "validationId": { "in": "path", "name": "validation-id", "description": "The unique identifier of the Validation", "required": true, "schema": { "$ref": "#/components/schemas/resourceId" } } }, "responses": { "SurchargeEligibilitySuccessfulResponse": { "description": "surcharge eligible response", "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/SurchargeEligibility" }, "example": { "merchantId": "0030200564948", "amount": { "amount": 5600, "currency": "CAD" }, "surchargeMessage": "Surcharge eligible", "maximumSurchargeRate": 2.4, "maximumSurchargeAmount": { "amount": 134, "currency": "CAD" }, "paymentMethod": { "paymentMethodId": "pm0001JYKTKZM2R5BXDFF1QGGXYRYP", "merchantId": "0030200564948", "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", "cardInformation": { "bankIdentificationNumber": "424242", "lastFour": "4242", "expiryMonth": 1, "expiryYear": 2026, "cardBrand": "VISA", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE", "paymentMethodSource": "CARD" }, "createdAt": "2025-06-25T15:17:05.285Z", "modifiedAt": "2025-06-25T15:17:05.285Z", "customData": { "property1": "string", "property2": "string" } } } } } }, "assertKountInquiryAcceptedResponse": { "description": "Kount Inquiry updated and is under review.", "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/kountInquiry" } } } }, "assertKountInquirySuccessResponse": { "description": "Kount Assert operation result response", "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/kountInquiry" } } } }, "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" } } } }, "cancelPaymentSuccessResponse": { "description": "Payment canceled 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/payment" }, "example": { "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": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "CANCELED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } } } } }, "cancelPaymentUnprocessableContentResponse": { "description": "Failed to cancel Payment operation result response", "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": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" }, "invalid_request": { "$ref": "#/components/examples/InvalidPurchaseErrorResponse" } } } } }, "cancelSubscriptionSuccessResponse": { "description": "Subscription canceled 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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": null, "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "CANCELED", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "completePaymentBadRequestResponse": { "description": "Failed to complete purchase", "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": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" }, "invalid_request": { "$ref": "#/components/examples/InvalidPurchaseErrorResponse" } } } } }, "completePaymentSuccessResponse": { "description": "Payment completed 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/payment" }, "example": { "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": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": null } } } }, "completePaymentUnprocessableContentResponse": { "description": "Failed Payment operation result response", "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": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" } } } } }, "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" } } } } }, "conflict": { "description": "Request could not be completed due to a conflict with resource state or existing idempotency key.", "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": { "idempotency_error": { "$ref": "#/components/examples/IdempotencyRequestErrorResponse" } } } } }, "createCustomerSuccessResponse": { "description": "Customer operation result response", "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/customer" } } } }, "createKountInquiryAcceptedResponse": { "description": "Kount Inquiry accepted and is under review.", "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/kountInquiry" } } } }, "createKountInquirySuccessResponse": { "description": "Kount Inquiry was successfully approved.", "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/kountInquiry" } } } }, "createPaymentBadRequestResponse": { "description": "Failed Payment operation result response", "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": { "invalid_request": { "$ref": "#/components/examples/InvalidRequestErrorResponse" } } } } }, "createPaymentMethodSuccessResponse": { "description": "Payment method created successfully. Response content contains the created payment method.\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/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" } } } } }, "createPaymentSuccessResponse": { "description": "Payment operation created 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/payment" }, "examples": { "PurchaseCompleted": { "$ref": "#/components/examples/PurchaseCompletedResponse" }, "PreauthorizationCompletedResponse": { "$ref": "#/components/examples/PreauthorizationCompletedResponse" } } } } }, "createPaymentUnprocessableContentResponse": { "description": "Failed Payment operation result response", "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": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" } } } } }, "createRefundBadRequestResponse": { "description": "Invalid Refund 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/json": { "schema": { "$ref": "#/components/schemas/error" }, "examples": { "invalid_request": { "$ref": "#/components/examples/InvalidRefundErrorResponse" } } } } }, "createRefundDeclinedResponse": { "description": "Refund operation declined", "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" }, "examples": { "declined": { "$ref": "#/components/examples/DeclineErrorResponse" } } } } }, "createRefundSuccessResponse": { "description": "Refund operation result response", "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/refund" }, "example": { "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV", "payment": { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": "0123456789101", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "refundAmount": { "amount": 1600, "currency": "CAD" }, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "refundStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "SUCCESS", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "reason": "Defective product", "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } } } } }, "createSubscriptionSuccessResponse": { "description": "Subscription created 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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "ACTIVE", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "createThreeDSecureAuthenticationChallengeResponse": { "description": "MPI Authentication operation resulted in a challenge.", "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/threeDSecureAuthentication" } } } }, "createThreeDSecureAuthenticationSuccessResponse": { "description": "3DS Secure authentication was successfully created & executed.", "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/threeDSecureAuthentication" } } } }, "createThreeDSecureCardLookupSuccessResponse": { "description": "3D-Secure Card Lookup created 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/cardLookup" } } } }, "customerDeleteSuccessResponse": { "description": "Customer deleted 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" } } }, "customerNotFoundResponse": { "description": "Customer 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": "/customers/ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "category": "INVALID_REQUEST_ERROR", "errors": [] } } } }, "customerUpdateSuccessResponse": { "description": "Customer 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/customer" } } } }, "disputeAcceptSuccess": { "description": "The dispute has been accepted 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" } } }, "extendSubscriptionSuccessResponse": { "description": "Subscription extended 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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 14, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-08-16" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "ACTIVE", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "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": [] } } } }, "getDisputeSuccess": { "description": "OK", "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/dispute" }, "example": { "imageUploadAllowed": false, "acceptAllowed": false, "caseRecordNumber": "1", "caseId": "121719004438", "documents": [ { "receivedAt": "2023-01-01T00:00:00Z", "fileName": "evidence1.jpg", "totalPages": 1, "images": [ { "image": "base64encodedstring", "pageNo": 1 } ] }, { "receivedAt": "2023-01-02T00:00:00Z", "fileName": "evidence2.jpg", "totalPages": 1, "images": [ { "image": "base64encodedstring", "pageNo": 1 }, { "image": "base64encodedstring", "pageNo": 2 } ] } ] } } } }, "getUploadStatusSuccess": { "description": "Upload Status retrieved 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/uploadStatus" } } } }, "incrementalAuthorizationSuccessResponse": { "description": "Incremental Authorization successfully created. Authorized Payment amount incremented 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/payment" }, "example": { "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": 20000, "currency": "CAD" }, "authorizedAmount": { "amount": 36000, "currency": "CAD" }, "capturableAmount": { "amount": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "INCREMENTED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" }, "incrementalAuthorizations": [ { "amount": { "amount": 10000, "currency": "CAD" }, "createdAt": "2025-07-30T06:43:40.252Z" }, { "amount": { "amount": 20000, "currency": "CAD" }, "createdAt": "2025-08-30T06:43:40.252Z" } ] } } } }, "installmentLookupResponse": { "description": "List of eligible plans.", "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/installmentEligibilityResponse" } } } }, "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": [] } } } }, "invalidListbadRequest": { "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" }, "examples": { "idempotency_error": { "$ref": "#/components/examples/InvalidListRequestErrorResponse" } } } } }, "listCustomersSuccessResponse": { "description": "List of all customers", "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/customerList" } } } }, "listKountInquiriesSuccessResponse": { "description": "Kount Inquiry operation result response", "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/kountInquiryList" } } } }, "listPaymentMethodsResponse": { "description": "Paginated list of payment methods", "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/paymentMethodList" }, "example": { "data": [ { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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" } }, { "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "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" } } ], "self": "/payment-methods?cursor=d41d8cd98f00b&limit=50", "first": "/payment-methods?cursor=d41d8cd98f00b&limit=50", "last": "/payment-methods?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "listPaymentsResponse": { "description": "List of all payments", "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/paymentList" }, "example": { "data": [ { "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": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } }, { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAZ", "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": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "CANCELED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } }, { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAX", "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": 0, "currency": "CAD" }, "capturableAmount": { "amount": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "DECLINED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "43", "responseCode": "421", "message": "Stolen card, pick up.", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } } ], "self": "/payments?cursor=d41d8cd98f00b&limit=50", "first": "/payments?cursor=d41d8cd98f00b&limit=50", "last": "/payments?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "listRefundsSuccessResponse": { "description": "Refund list successfully returned.", "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/refundList" }, "example": { "data": [ { "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV", "payment": { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": "0123456789101", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "refundAmount": { "amount": 1600, "currency": "CAD" }, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "refundStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "SUCCESS", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "reason": "Defective product", "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } }, { "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV", "payment": { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": "0123456789101", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "refundAmount": { "amount": 1600, "currency": "CAD" }, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "refundStatus": "DECLINED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "51", "responseCode": "054", "message": "Expired Card", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "reason": "Defective product", "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } } ], "self": "/refunds?cursor=d41d8cd98f00b&limit=50", "first": "/refunds?cursor=d41d8cd98f00b&limit=50", "last": "/refunds?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "listSubscriptionsResponse": { "description": "Paginated list of subscriptions.", "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/subscriptionList" } } } }, "listValidationsSuccessResponse": { "description": "List of Card Validations", "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/validationList" }, "example": { "data": [ { "validationId": "vi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "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" } }, "validationStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH" }, "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } }, { "validationId": "vi0105ARZ3NDEKTSV4RRFFQ69G5FAX", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "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" } }, "validationStatus": "DECLINED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "43", "responseCode": "421", "message": "Stolen card, pick up.", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH" }, "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } } ], "self": "/validations?cursor=d41d8cd98f00b&limit=50", "first": "/validations?cursor=d41d8cd98f00b&limit=50", "last": "/validations?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "multiCurrencyPricingRateLookup": { "description": "Multi-Currency Pricing (MCP) Rate lookup Response", "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/multiCurrencyPricingRateLookup" } } } }, "notFound": { "description": "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/problem+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": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "category": "INVALID_REQUEST_ERROR", "errors": [] } } } }, "pauseSubscriptionSuccessResponse": { "description": "Subscription paused 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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": null, "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "PAUSED", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "paymentMethodDeleteSuccessResponse": { "description": "Payment method deleted successfully. \nResponse content contains the payment method details.\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" } } }, "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" } } } } }, "refundNotFoundResponse": { "description": "Refund 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": { "data": [ { "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV", "payment": { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": "0123456789101", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "refundAmount": { "amount": 1600, "currency": "CAD" }, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "refundStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "SUCCESS", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "reason": "Defective product", "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } }, { "refundId": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV", "payment": { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "merchantId": "0123456789101", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "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": null, "customData": { "property1": "string", "property2": "string" } }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "refundAmount": { "amount": 1600, "currency": "CAD" }, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "refundStatus": "DECLINED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "51", "responseCode": "054", "message": "Expired Card", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE" }, "reason": "Defective product", "credentialOnFileResponse": null, "customData": { "property1": "string", "property2": "string" } } ], "self": "/refunds?cursor=d41d8cd98f00b&limit=50", "first": "/refunds?cursor=d41d8cd98f00b&limit=50", "last": "/refunds?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "resumeSubscriptionSuccessResponse": { "description": "Subscription resumed 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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "ACTIVE", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "retrieveCustomerSuccessResponse": { "description": "The customer corresponding to the provided `customerId`", "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/customer" } } } }, "retrieveKountInquiryResponse": { "description": "Retrieve Kount Inquiry response", "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/kountInquiry" } } } }, "retrievePaymentMethodSuccessResponse": { "description": "Payment method found and returned in the response.", "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" } } } } }, "retrievePaymentSuccessResponse": { "description": "The payment corresponding to the provided `payment-id`", "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/payment" }, "examples": { "succeeded": { "$ref": "#/components/examples/PurchaseCompletedResponse" }, "authorized": { "$ref": "#/components/examples/PreauthorizationCompletedResponse" }, "declined": { "$ref": "#/components/examples/PurchaseDeclinedResponse" }, "declined_retry": { "$ref": "#/components/examples/PurchaseDeclinedRetryResponse" }, "canceled": { "$ref": "#/components/examples/PurchaseCanceledResponse" } } } } }, "retrieveRefundSuccessResponse": { "description": "Successfully retrieved the refund corresponding to the provided `refund-id`", "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/refund" }, "examples": { "succeeded": { "$ref": "#/components/examples/SucceededRefundResponse" }, "declined": { "$ref": "#/components/examples/DeclinedRefundResponse" } } } } }, "retrieveSubscriptionSuccessResponse": { "description": "Subscription successfully found and returned in the response.", "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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "ACTIVE", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "retrieveThreeDSecureAuthenticationSuccessResponse": { "description": "The authentication corresponding to the provided `authentication-id`", "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/threeDSecureAuthentication" } } } }, "retrieveValidationSuccessResponse": { "description": "Card Validation retrieved 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/validation" }, "examples": { "succeeded": { "$ref": "#/components/examples/ValidationSucceededResponse" }, "declined": { "$ref": "#/components/examples/ValidationDeclinedRetryResponse" }, "declined_retry": { "$ref": "#/components/examples/ValidationDeclinedResponse" } } } } }, "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": [] } } } }, "threeDSecureAuthenticationLookupSuccessResponse": { "description": "MPI Authentication operation was successfully authenticated.", "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/threeDSecureAuthentication" } } } }, "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" } } }, "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": [] } } } }, "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" } } } }, "updateSubscriptionSuccessResponse": { "description": "Subscription billing details successfully updated.", "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/subscription" }, "example": { "subscriptionId": "rp0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "billingInformation": { "billingIntervalUnit": "WEEK", "billingIntervalFrequency": 2, "billingIntervalCount": 2, "billingAmount": { "amount": 2500, "currency": "CAD" }, "billingStartDate": "2025-02-01", "nextBillingDate": "2025-02-14", "billingEndDate": "2025-02-28" }, "callbackUrl": "https://myserver.com/send/callback/here", "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": { "paymentMethodType": "CARD", "paymentMethodSource": "TEMPORARY_TOKEN", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2023-02-25T06:43:40.252Z", "modifiedAt": "2023-02-26T06:43:40.252Z", "customData": { "property1": "string", "property2": "string" } }, "subscriptionStatus": "ACTIVE", "oneTimeAmount": { "amount": 16000, "currency": "CAD" }, "credentialOnFileResponse": { "originalAmount": { "amount": 15000, "currency": "CAD" }, "issuerId": "A" }, "payments": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" } ] } } } }, "uploadDisputeImagesSuccess": { "description": "Dispute image upload has been accepted.", "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" }, "Location": { "$ref": "#/components/headers/location" } } }, "validationNotFoundResponse": { "description": "Card validation 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": "/validations/vi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "category": "INVALID_REQUEST_ERROR", "errors": [] } } } } }, "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" } } } } } } }