Learn more
Read more about the launch of our MCP server in our tech blog.
Our Model Context Protocol (MCP) server lets you use natural language with your chosen Large Language Model (LLM) client. This allows developers to use conversational AI to connect with Adyen's platform more easily and build new payment solutions faster.
How it works
Use our MCP server to integrate with our APIs through function calling. This lets you integrate and interact with Adyen APIs seamlessly. The pilot release contains an initial set of tools that let you interact with the Adyen APIs for common use cases, using your client of choice.
To get started:
- Get your API credentials to authenticate the API requests you will make with our MCP server.
- Run the MCP server.
- Use our MCP with an LLM client to interact with our APIs using natural language.
Get your API credentials
To authenticate the requests you will make using the MCP, generate an API key. You will need your API key when running the MCP server.
Make sure that your API credential has the following roles, these roles are assigned to all web service users by default:
- Merchant PAL webservice role
- Checkout webservice role
- Management API—Payment methods read
- Management API—Account read
Run the MCP server
Run our MCP server locally to start interacting with our APIs using natural language. You need your API key to run the server, and authenticate API requests.
Test environment
You must have the following to run the MCP server in your test environment:
- Your Adyen API key.
Run the following command:
Live environment
You must have the following to run the MCP server in your live environment:
- Your Adyen API key.
- Your Adyen live URL prefix from your live Customer Area under Developers > API URLs > Prefix.
Run the following command:
Use the MCP server
After you start running the MCP server locally, use an LLM client of your choice to interact with our APIs using natural language.
Interactions with our MCP server consist of the following:
- Your prompt: You provide instructions to your LLM client using natural language. For example, "Refund order #12345" or "Create a €50 payment link for order #ABC789."
- LLM client: Your LLM client sends these instructions to the Adyen MCP server.
- The MCP server: Our MCP server uses converts these instructions into the specific Adyen API requests needed to perform the task using function calling.
- API request: The MCP server makes the API requests to carry out the task you asked for, like making a refund or creating a payment link.
Supported APIs and endpoints
The pilot MCP supports the following endpoints. We are working on adding support for more APIs and endpoints.
Tool | Description | |
---|---|---|
get_payment_methods |
Makes a POST /paymentMethods request to get a list of all available payment methods for a transaction. | |
create_payment_session |
Makes a POST /sessions request to create a payment session. | |
get_payment_session |
Makes a POST /sessions/{sessionId} request to get the result of a payment session. | |
create_payment_links |
Makes a POST /paymentLinks request to create a payment link. | |
get_payment_link |
Makes a GET /paymentLinks/{linkId} request to retrieve the payment details for a payment link. | |
update_payment_link |
Makes a PATCH /paymentLinks/{linkId} request to force the expiry of a payment link. | |
refund_payment |
Makes a POST /payments/{paymentPspReference}/refunds request to refund a payment. | |
cancel_payment |
Makes a POST /payments/{paymentPspReference}/cancels request to cancel a payment. | |
list_merchant_accounts |
Makes a GET /merchants request to get a list of all merchant accounts you have access to. |
See also
- API credentials
- Checkout API on API explorer
- Management API on API explorer
- Adyen on GitHub