MCP Server and Resource Metrics
- Server URL:
https://<domain>/payment/mcp - Total Tools: 80
- Total Error Codes: 12
Server Overview
The MCP server offers robust payment management capabilities, enabling seamless operations like payment processing, transaction creation, collection management, and provider integration, while ensuring secure data handling, role-based access, and extensive support for filtering, sorting, and error handling across its 80 specialized tools.
Tools
The following table lists the available MCP tools for Payment service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getPaymentOption | This tool retrieves payment option details for an app using a unique payment option ID, with various response codes indicating success or errors. |
|
|
| updatePaymentOption | This tool updates a payment option using its unique payment option ID and provides detailed responses for various statuses. |
|
|
| deletePaymentOption | This tool deletes a payment option for an app using its unique payment option ID, returning various status codes based on the operation’s outcome. |
|
|
| patchPaymentOption | This tool updates an app’s payment option using a unique payment option ID and provides detailed responses for success or various error scenarios. |
|
|
| getPaymentOptionsRuleById | This tool retrieves payment option rules based on a specified payment option ID and rule ID, returning detailed response data or error codes. |
|
|
| updatePaymentOptionsRuleById | This tool updates a payment option rule using its unique payment option ID and rule ID, returning detailed success or error responses. |
|
|
| patchUpdatePaymentOptionsRuleById | This tool patch updates a payment option rule using its payment option ID and rule ID, returning success or error responses. |
|
|
| updatePaymentOptionProperty | This tool updates payment option properties using a unique payment option ID, with various response codes for success or errors. |
|
|
| patchPaymentOptionProperty | This tool patch updates payment option properties using a unique payment option ID, with detailed response codes for success and errors. |
|
|
| updatePaymentOptionsRanking | This tool updates payment option rankings using a unique ranking ID and provides detailed responses for success or various error scenarios. |
|
|
| getCollection | This tool facilitates loading a payment collection using specified collection and business identifiers, with detailed response codes for various outcomes. |
|
|
| replaceCollection | This tool updates a payment collection by modifying all attributes, requiring all associated properties to be passed in the request. |
|
|
| replaceCollectionProperties | This tool updates collection properties based on identifiers and returns success or error responses in JSON format. |
|
|
| updateCollectionProperties | This tool patch updates collection properties and handles various response codes for operations on microservice collections. |
|
|
| createTransaction | This tool enables authorized users to create transactions linked to a payment item ID, interacting with third-party services to set transaction details and statuses. |
|
|
| reCreateTransaction | This tool recreates transactions based on a request, connects to third-party services, updates status, and requires specific roles and privileges for execution. |
|
|
| refreshApi | This tool updates secret keys without a restart, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getProviderMasters | This tool retrieves provider master details as an array of ProviderMaster models, accessible only to users with specific roles and privileges. |
|
|
| createProviderMaster | This tool creates a provider master based on a valid ProviderMaster JSON request, supports various processor classes, and enforces transaction constraints with detailed responses for success or errors. |
|
|
| createCustomerAndSetupIntent | Payment token responses include success (201), errors (400, 417, 422, 500), and detailed properties for user, type, and processor feedback in JSON format. |
|
|
| getPayments | This tool retrieves payments from a collection based on a search term or collection ID, accessible to authorized users with specific roles and privileges. |
|
|
| createPayment | This tool creates payments based on requests, generates tokens for card transactions, enforces strict property rules, and supports default payment management with specific user roles. |
|
|
| recreatePayment | This tool creates payments with predefined properties, validates inputs, supports default payment updates, and ensures secure handling of card details using tokens. |
|
|
| handleCompletingPayment | This tool manages external payment transactions, providing detailed responses for success, errors, or failed expectations. |
|
|
| dynamicAppApi | This tool manages external payment outcomes with detailed response codes and properties for various statuses. |
|
|
| getALLPaymentOption | This tool retrieves all payment options with filtering, pagination, sorting, and detailed response codes. |
|
|
| createPaymentOption | This tool generates a payment option using request data and provides detailed responses for success, errors, or conflicts. |
|
|
| getEligiblePaymentOption | This tool retrieves eligible payment options for an order based on predefined payment rules, with various response codes indicating success or errors. |
|
|
| getAllPaymentOptionRankings | This tool retrieves payment option rankings with filtering, pagination, sorting, and detailed response codes. |
|
|
| createPaymentOptionsRanking | This tool generates ranked payment options and provides detailed response codes for success or errors. |
|
|
| createPaymentItem | This tool allows privileged users to create payment items with mandatory fields like paymentId, value, and currencyCode, returning responses in the PaymentItem model. |
|
|
| registerPayment | This tool registers a payment using payment details and a payment option ID, returning various response codes and URLs based on success or errors. |
|
|
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and can clear entire caches if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and returns a JSON response with a code, message, and timestamp. |
|
|
| getCollections | This tool retrieves payment collections with filtering, pagination, and detailed error responses. |
|
|
| createCollection | This tool manages payment collections by updating existing properties or using defaults, while disallowing new properties, and provides detailed responses for various request outcomes. |
|
|
| getCollectionProviders | This tool retrieves collection providers based on a search term or collection ID, accessible only to authorized users, with paginated responses and various status codes. |
|
|
| createCollectionProvider | This tool enables authorized users to create a collection provider for mapping provider masters to collections, ensuring unique mappings and facilitating third-party transaction services. |
|
|
| createTransactions | This tool processes bulk transaction requests, ensuring unique payment items, connects to third-party services for status updates, and supports specific user roles for transaction creation. |
|
|
| getTransaction | This tool retrieves transaction details by ID, requiring view privileges, with responses based on the Transaction model and user roles. |
|
|
| deleteTransaction | This tool deletes a transaction using a valid transaction ID, accessible only to authorized users with specific roles or privileges. |
|
|
| getTransaction_1 | This tool updates transaction attributes like `status` and `properties` based on transaction ID, requiring ‘update transaction’ privilege, with responses defined in the `Transaction` model. |
|
|
| getProviderMaster | This tool retrieves provider master details by ID, requiring ‘view provider master’ privilege and ROLE_PAYMENT_ADMIN access. |
|
|
| deleteProviderMaster | This tool deletes a provider master by ID, requiring specific user privileges and returns a response as a string. |
|
|
| updateProviderMaster | This tool patch allows authorized users to update provider master details such as name, supported types, and properties using a specified providerMasterId. |
|
|
| getPayment | This tool retrieves payment details for a specified payment ID within a collection, requiring ‘view payment’ privileges, with responses defined in the Payment model. |
|
|
| deletePayment | This tool deletes a payment by ID, including associated child entities, and requires specific user roles with ‘delete payment’ privileges. |
|
|
| updatePayment | This tool allows privileged users to update payment fields, potentially creating a new payment with inactive status if third-party token updates are required, and provides detailed responses based on operation outcomes. |
|
|
| getPaymentItem | This tool retrieves payment item details by ID within a collection, accessible to authorized roles, with responses based on success or error codes. |
|
|
| deletePaymentItem | This tool deletes a payment item by ID, including associated child entities, requiring specific user roles or privileges, and provides responses in JSON format. |
|
|
| updatePaymentItem | This tool allows privileged users to update payment item fields (excluding IDs) with responses defined in the PaymentItem model, supporting various roles and error handling. |
|
|
| getCollectionProvider | This tool retrieves a collection provider by ID within a collection, requiring ‘view collection provider’ privilege, and returns details in the CollectionProvider model. |
|
|
| deleteCollectionProvider | This tool deletes a collection provider by ID, requiring specific privileges, and returns a string response with various status codes. |
|
|
| updateCollectionProvider | This tool allows privileged users to update collection provider attributes, excluding IDs, with responses defined in the CollectionProvider model. |
|
|
| getTransactionByRequestId | The tool retrieves transaction details by a unique request ID, returning status, type, and other properties in JSON format for various response codes. |
|
|
| getTransactionProperty | This tool retrieves transaction details based on property name and value, requiring ‘view transaction’ privileges or specific roles. |
|
|
| refreshApi_1 | This tool updates secret keys without a restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS calls, and requires keyName and resetRequired parameters. |
|
None |
| refreshApi_2 | This tool updates secret keys without a restart, cleans instance data for AWS calls, and requires `keyName` and `resetRequired` parameters. |
|
None |
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges from `roles_privileges.json` but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service with detailed response codes and properties. |
|
None |
| getAllPrivileges | This tool fetches service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning them in JSON format upon success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool checks the availability of the Payment service and provides success, not found, or default responses. |
|
None |
| getPaymentItems | This tool retrieves payment items based on a search term or collection ID, with access restricted by user roles and detailed response formats. |
|
|
| getPayments_1 | This tool retrieves payments from a collection based on search terms or collection ID, with access restricted by user roles and privileges. |
|
|
| getPrimaryPayment | This tool retrieves the user’s default payment details within a collection, requiring ‘view payment’ privilege and specific roles, with responses defined in the Payment model. |
|
|
| getAllPaymentOptionsRules | This tool retrieves payment option details for an app using a unique payment option ID, with support for filters, pagination, sorting, and various response statuses. |
|
|
| getPaymentOptionProperty | This tool retrieves payment option properties using a unique payment option ID and property name, returning details or error responses. |
|
|
| getTransactions | This tool retrieves transactions from a collection based on a search term or collection ID, accessible to authorized roles, with paginated and filtered responses. |
|
|
| getCollection_1 | This tool generates or retrieves RSA key pairs, returning the public key for encrypting application data in payment tools, with detailed parameters and response codes. |
|
|
| getCacheValue | This tool retrieves cached data for a specified service using string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionPropertyByName | This tool retrieves a collection’s property by name using specified parameters and returns responses based on the operation’s outcome. |
|
|
| getCollectionAttributes | This tool retrieves payment collection attributes with responses for success, bad request, and forbidden scenarios. |
|
|
| deleteTransactionProperty | This tool deletes a transaction property by transaction ID and property name, requiring specific user roles and privileges. |
|
|
| deleteProviderMasterProperty | This tool deletes a provider master property by ID and name, requiring specific privileges and roles, with responses indicating success or resource not found. |
|
|
| deletePaymentProperty | This tool deletes a payment property for a given payment ID and property name, requiring specific user roles and privileges, with responses provided in JSON format. |
|
|
| deletePaymentItemProperty | This tool allows authorized users to delete a payment item’s property by its ID and name, returning a string response. |
|
|
| deleteCollectionProvider PropertyByName |
This tool deletes a collection provider’s property using the provider ID and property name, accessible only to authorized users, with responses in JSON format. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): OK |
| 201 | (Success): Success |
| 204 | (Success): No Content |
| 302 | Found |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 409 | Conflict |
| 417 | Expectation failed |
| 422 | Invalid Request |
| 500 | Internal Server error |
Useful Resources
- API Specifications: API Endpoints – Payment
- Services Details: Payment Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added