Adyen

Adyen Merchants API

The Merchants API from Adyen — 38 operation(s) for merchants.

GitHub OpenAPI

Operations 67

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /merchants List the merchant accounts I can access · Adyen Get a List of Merchant Accounts #
Ask an LLM
“Which Adyen merchant accounts can my API credential see?”
“Can I page through all my merchant accounts 100 at a time?”
Tell an agent
List every merchant account my credential has access to.
Show page {pageNumber} of my merchant accounts with {pageSize} per page.
POST /merchants Create a new merchant account under a company · Adyen Create a Merchant Account #
Ask an LLM
“How do I open a new merchant account under my company account?”
“Can I attach a pricing plan and sales channels when creating a merchant account?”
Tell an agent
Create a merchant account under company {companyId}.
Create a merchant account for company {companyId} tied to legal entity {legalEntityId} with reference {reference}.
GET /merchants/{merchantId} Look up one merchant account · Adyen Get a Merchant Account #
Ask an LLM
“What details are stored on a specific merchant account?”
“Can I check the status of a single merchant account by its ID?”
Tell an agent
Get the details of merchant account {merchantId}.
Show me merchant {merchantId}.
POST /merchants/{merchantId}/activate Request activation of a merchant account · Adyen Request to Activate a Merchant Account #
Ask an LLM
“How do I get a newly created merchant account activated?”
“Where do I find out whether a merchant activation request succeeded?”
Tell an agent
Request activation for merchant account {merchantId}.
Send the activation request for {merchantId} so it can start processing.
GET /merchants/{merchantId}/apiCredentials List a merchant account's API credentials · Adyen Get a List of API Credentials #
Ask an LLM
“Which API credentials exist on my merchant account?”
“Can I see all the API users set up for one merchant?”
Tell an agent
List the API credentials on merchant {merchantId}.
Show page {pageNumber} of API credentials for merchant {merchantId}.
POST /merchants/{merchantId}/apiCredentials Create an API credential for a merchant · Adyen Create an API Credential #
Ask an LLM
“How do I create a new API credential scoped to one merchant account?”
“Can I set roles and allowed origins when I create a merchant API credential?”
Tell an agent
Create a new API credential on merchant {merchantId}.
Create an API credential for merchant {merchantId} with roles {roles} and allowed origins {allowedOrigins}.
GET /merchants/{merchantId}/apiCredentials/{apiCredentialId} Get one merchant API credential · Adyen Get an API Credential #
Ask an LLM
“What roles does a particular merchant API credential have?”
“Is a given API credential on my merchant still active?”
Tell an agent
Get API credential {apiCredentialId} on merchant {merchantId}.
Show the roles and origins of credential {apiCredentialId} for merchant {merchantId}.
PATCH /merchants/{merchantId}/apiCredentials/{apiCredentialId} Change a merchant API credential's roles or origins · Adyen Update an API Credential #
Ask an LLM
“Can I change the roles on an existing merchant API credential?”
“How do I deactivate a merchant API credential without deleting it?”
Tell an agent
Update the roles of credential {apiCredentialId} on merchant {merchantId} to {roles}.
Set credential {apiCredentialId} on merchant {merchantId} to active {active}.
GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins List allowed origins for a merchant credential · Adyen Get a List of Allowed Origins #
Ask an LLM
“Which domains are allowed to make client-side calls with my merchant credential?”
“What allowed origins are configured on a merchant API credential?”
Tell an agent
List the allowed origins of credential {apiCredentialId} on merchant {merchantId}.
Show every domain whitelisted for merchant {merchantId} credential {apiCredentialId}.
POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins Add an allowed origin to a merchant credential · Adyen Create an Allowed Origin #
Ask an LLM
“How do I allow a new website domain to use my merchant client key?”
“Can I add one more allowed origin to an existing merchant credential?”
Tell an agent
Add {domain} as an allowed origin on credential {apiCredentialId} for merchant {merchantId}.
Allow client-side requests from {domain} for merchant {merchantId} credential {apiCredentialId}.
DELETE /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Remove an allowed origin from a merchant credential · Adyen Delete an Allowed Origin #
Ask an LLM
“How do I stop a domain from making client-side requests with my merchant credential?”
“What happens right after I remove an allowed origin?”
Tell an agent destructive · confirm first
Delete allowed origin {originId} from credential {apiCredentialId} on merchant {merchantId}.
Revoke origin {originId} for merchant {merchantId} credential {apiCredentialId}.
GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Get one allowed origin on a merchant credential · Adyen Get an Allowed Origin #
Ask an LLM
“What domain does a specific allowed origin ID on my merchant credential point to?”
“Can I look up a single allowed origin by its ID?”
Tell an agent
Get allowed origin {originId} on credential {apiCredentialId} for merchant {merchantId}.
Show origin {originId} of merchant {merchantId} credential {apiCredentialId}.
POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey Rotate the API key of a merchant credential · Adyen Generate New API Key #
Ask an LLM
“How do I rotate the API key on a merchant-level credential?”
“How long does the old merchant API key keep working after I generate a new one?”
Tell an agent
Generate a new API key for credential {apiCredentialId} on merchant {merchantId}.
Rotate the server API key of merchant {merchantId} credential {apiCredentialId}.
POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey Rotate the client key of a merchant credential · Adyen Generate New Client Key #
Ask an LLM
“Can I issue a fresh client key for my merchant's checkout front end?”
“When does the previous client key stop working after rotation?”
Tell an agent
Generate a new client key for credential {apiCredentialId} on merchant {merchantId}.
Rotate the client-side key of merchant {merchantId} credential {apiCredentialId}.
GET /merchants/{merchantId}/billingEntities List billing entities for terminal orders · Adyen Get a List of Billing Entities #
Ask an LLM
“Which legal entities can terminal orders for my merchant be billed to?”
“Can I search a merchant's billing entities by name?”
Tell an agent
List the billing entities of merchant {merchantId}.
Find billing entities named {name} for merchant {merchantId}.
GET /merchants/{merchantId}/paymentMethodSettings List payment methods enabled on a merchant · Adyen Get All Payment Methods #
Ask an LLM
“Which payment methods are configured on my merchant account?”
“Can I filter a merchant's payment methods down to one store?”
Tell an agent
List all payment methods for merchant {merchantId}.
Show the payment methods of merchant {merchantId} for store {storeId}.
POST /merchants/{merchantId}/paymentMethodSettings Request a new payment method for a merchant · Adyen Request a Payment Method #
Ask an LLM
“How do I request that a new payment method be added to my merchant account?”
“Can I limit a newly requested payment method to certain countries and currencies?”
Tell an agent
Request payment method type {type} for merchant {merchantId}.
Request {type} on merchant {merchantId} for countries {countries} and currencies {currencies}.
GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} Get one payment method's settings · Adyen Get Payment Method Details #
Ask an LLM
“What countries and currencies does a specific payment method on my merchant support?”
“Is a particular payment method enabled on my merchant account?”
Tell an agent
Get payment method {paymentMethodId} on merchant {merchantId}.
Show the configuration of payment method {paymentMethodId} for {merchantId}.
PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} Update or disable an existing payment method · Adyen Update a Payment Method #
Ask an LLM
“Can I switch off a payment method that's already set up on my merchant?”
“How do I change which stores an existing payment method applies to?”
Tell an agent
Set payment method {paymentMethodId} on merchant {merchantId} to enabled {enabled}.
Limit payment method {paymentMethodId} of merchant {merchantId} to stores {storeIds}.
POST /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains Register an Apple Pay domain · Adyen Add an Apple Pay Domain #
Ask an LLM
“How do I register my website domain for Apple Pay on Adyen?”
“Can I add several Apple Pay domains at once?”
Tell an agent
Add Apple Pay domains {domains} to payment method {paymentMethodId} on merchant {merchantId}.
Register {domains} for Apple Pay under merchant {merchantId} method {paymentMethodId}.
GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains List registered Apple Pay domains · Adyen Get Apple Pay Domains #
Ask an LLM
“Which domains are already registered for Apple Pay on my merchant?”
“Is my checkout domain on the Apple Pay domain list yet?”
Tell an agent
List the Apple Pay domains on payment method {paymentMethodId} for merchant {merchantId}.
Show registered Apple Pay domains for merchant {merchantId} method {paymentMethodId}.
GET /merchants/{merchantId}/payoutSettings List a merchant's payout settings · Adyen Get a List of Payout Settings #
Ask an LLM
“Where do payouts from my merchant account get sent?”
“Which transfer instruments are linked to my merchant for payouts?”
Tell an agent
List the payout settings for merchant {merchantId}.
Show all payout destinations configured on {merchantId}.
POST /merchants/{merchantId}/payoutSettings Link a transfer instrument for payouts · Adyen Add a Payout Setting #
Ask an LLM
“How do I link a bank account to my merchant so it receives payouts?”
“Can I schedule a new payout setting to take effect from a later date?”
Tell an agent
Add a payout setting on merchant {merchantId} using transfer instrument {transferInstrumentId}.
Pay out merchant {merchantId} to instrument {transferInstrumentId} starting {enabledFromDate}.
DELETE /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Delete a payout setting · Adyen Delete a Payout Setting #
Ask an LLM
“How do I remove a payout destination from my merchant account entirely?”
“Can I delete a payout setting I no longer need?”
Tell an agent destructive · confirm first
Delete payout setting {payoutSettingsId} from merchant {merchantId}.
Remove the payout setting {payoutSettingsId} on {merchantId} permanently.
GET /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Get one payout setting · Adyen Get a Payout Setting #
Ask an LLM
“Is a specific payout setting on my merchant enabled?”
“Which transfer instrument does a given payout setting use?”
Tell an agent
Get payout setting {payoutSettingsId} for merchant {merchantId}.
Show the details of payout setting {payoutSettingsId} on {merchantId}.
PATCH /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Enable or disable a payout setting · Adyen Update a Payout Setting #
Ask an LLM
“Can I pause payouts to one bank account without deleting the setting?”
“How do I turn a disabled payout setting back on?”
Tell an agent
Set payout setting {payoutSettingsId} on merchant {merchantId} to enabled {enabled}.
Disable payout setting {payoutSettingsId} for {merchantId}.
GET /merchants/{merchantId}/shippingLocations List shipping locations for terminal orders · Adyen Get a List of Shipping Locations #
Ask an LLM
“Which addresses can my terminal orders be shipped to?”
“Can I search my merchant's shipping locations by name?”
Tell an agent
List shipping locations for merchant {merchantId}.
Find the shipping location called {name} on merchant {merchantId}.
POST /merchants/{merchantId}/shippingLocations Add a shipping address for terminal orders · Adyen Create a Shipping Location #
Ask an LLM
“How do I add a new delivery address for terminal hardware orders?”
“Can I include a contact person on a shipping location?”
Tell an agent
Create shipping location {name} for merchant {merchantId} at {address}.
Add a shipping location on {merchantId} with contact {contact}.
GET /merchants/{merchantId}/splitConfigurations List a merchant's split configurations · Adyen Get a List of Split Configurations #
Ask an LLM
“Which split configuration profiles exist on my merchant account?”
“What split configurations can I assign to my stores?”
Tell an agent
List split configurations for merchant {merchantId}.
Show every split profile set up on {merchantId}.
POST /merchants/{merchantId}/splitConfigurations Create a split configuration profile · Adyen Create a Split Configuration #
Ask an LLM
“How do I set up rules that split each payment's funds automatically?”
“Can I apply a new split configuration to specific stores when I create it?”
Tell an agent
Create a split configuration on merchant {merchantId} described as {description} with rules {rules}.
Create split profile {description} on {merchantId} for stores {stores} using rules {rules}.
DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Delete a whole split configuration · Adyen Delete a Split Configuration #
Ask an LLM
“How do I delete an entire split configuration profile?”
“Can I remove a split profile I no longer use from my merchant?”
Tell an agent destructive · confirm first
Delete split configuration {splitConfigurationId} from merchant {merchantId}.
Remove the whole split profile {splitConfigurationId} on {merchantId}.
GET /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Get one split configuration · Adyen Get a Split Configuration #
Ask an LLM
“What rules are inside a specific split configuration?”
“Can I inspect one split profile by its ID?”
Tell an agent
Get split configuration {splitConfigurationId} on merchant {merchantId}.
Show the rules of split profile {splitConfigurationId} for {merchantId}.
PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Rename a split configuration's description · Adyen Update Split Configuration Description #
Ask an LLM
“Can I change the description of an existing split configuration?”
“Is it possible to relabel a split profile without touching its rules?”
Tell an agent
Change the description of split configuration {splitConfigurationId} on {merchantId} to {description}.
Relabel split profile {splitConfigurationId} of merchant {merchantId} as {description}.
POST /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Add a rule to a split configuration · Adyen Create a Rule #
Ask an LLM
“How do I add a rule for a specific payment method and currency to an existing split profile?”
“Can a split rule apply only to ecommerce or only to in-person payments?”
Tell an agent
Add a split rule to {splitConfigurationId} on {merchantId}: {paymentMethod}, {currency}, {shopperInteraction}, logic {splitLogic}.
Create a new split rule in profile {splitConfigurationId} of merchant {merchantId}.
DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} Delete one rule from a split configuration · Adyen Delete a Split Configuration Rule #
Ask an LLM
“How do I remove just one rule from a split profile and keep the rest?”
“Can I delete a single split rule by its ID?”
Tell an agent destructive · confirm first
Delete rule {ruleId} from split configuration {splitConfigurationId} on {merchantId}.
Remove split rule {ruleId} in profile {splitConfigurationId} of merchant {merchantId}.
PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} Change the conditions of a split rule · Adyen Update Split Conditions #
Ask an LLM
“Can I change which payment method or currency an existing split rule matches?”
“What conditions on a split rule can I edit after creating it?”
Tell an agent
Update rule {ruleId} in split configuration {splitConfigurationId} on {merchantId} to match {paymentMethod} in {currency} for {shopperInteraction}.
Restrict split rule {ruleId} of profile {splitConfigurationId} for {merchantId} to funding source {fundingSource}.
PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId} Change how a split rule divides funds and fees · Adyen Update the Split Logic #
Ask an LLM
“How do I change the commission my platform takes in a split rule?”
“Can I decide who pays chargebacks and scheme fees in a split?”
Tell an agent
Set the commission on split logic {splitLogicId} of rule {ruleId} in profile {splitConfigurationId} for {merchantId} to {commission}.
Allocate chargebacks as {chargeback} in split logic {splitLogicId}, rule {ruleId}, profile {splitConfigurationId}, merchant {merchantId}.
GET /merchants/{merchantId}/stores List a merchant's stores · Adyen Get a List of Stores #
Ask an LLM
“Which stores are set up under my merchant account?”
“Can I find a store under my merchant by its reference?”
Tell an agent
List the stores of merchant {merchantId}.
Find the store with reference {reference} under merchant {merchantId}.
POST /merchants/{merchantId}/stores Open a new store under a merchant · Adyen Create a Store #
Ask an LLM
“How do I add a physical store location to my merchant account?”
“What does a new store need, like a shopper statement and phone number?”
Tell an agent
Create store {description} for merchant {merchantId} at {address} with phone {phoneNumber} and shopper statement {shopperStatement}.
Add a store with reference {reference} under {merchantId}.
GET /merchants/{merchantId}/stores/{reference}/terminalLogos Get a store's terminal logo for a model · Adyen Get the Terminal Logo #
Ask an LLM
“What logo shows on a given terminal model at one particular store?”
“Can I download a store-level terminal logo as Base64?”
Tell an agent
Get the terminal logo for model {model} at store {reference} of merchant {merchantId}.
Show the store-specific logo on {model} terminals at store {reference} under {merchantId}.
PATCH /merchants/{merchantId}/stores/{reference}/terminalLogos Change a store's terminal logo for a model · Adyen Update the Terminal Logo #
Ask an LLM
“How do I put a different logo on the terminals at just one store?”
“Can I update the logo for more than one terminal model per request at store level?”
Tell an agent
Upload logo {data} for model {model} terminals at store {reference} of merchant {merchantId}.
Replace the store-level terminal logo on {model} at store {reference} under {merchantId}.
GET /merchants/{merchantId}/stores/{reference}/terminalSettings Get terminal settings for one store · Adyen Get Terminal Settings #
Ask an LLM
“What terminal settings apply to all the terminals at one store?”
“Which receipt and tipping options are configured for a store's terminals?”
Tell an agent
Get the terminal settings of store {reference} under merchant {merchantId}.
Show store-level terminal configuration for {reference} at {merchantId}.
PATCH /merchants/{merchantId}/stores/{reference}/terminalSettings Update terminal settings for one store · Adyen Update Terminal Settings #
Ask an LLM
“How do I turn on tipping for the terminals at a single store?”
“Can I change Wi-Fi profiles for every terminal in one store at once?”
Tell an agent
Update gratuity settings for terminals at store {reference} of merchant {merchantId} to {gratuities}.
Set the Wi-Fi profiles {wifiProfiles} on all terminals in store {reference} under {merchantId}.
GET /merchants/{merchantId}/stores/{storeId} Get one store's details · Adyen Get a Store #
Ask an LLM
“What address and status does a particular store have?”
“Can I look up a store by its store ID?”
Tell an agent
Get store {storeId} under merchant {merchantId}.
Show the details of store ID {storeId} for {merchantId}.
PATCH /merchants/{merchantId}/stores/{storeId} Update a store's details or status · Adyen Update a Store #
Ask an LLM
“Can I close or deactivate a store by changing its status?”
“How do I change the address or phone number of an existing store?”
Tell an agent
Set the status of store {storeId} under {merchantId} to {status}.
Change the phone number of store {storeId} for merchant {merchantId} to {phoneNumber}.
GET /merchants/{merchantId}/terminalLogos Get the merchant-wide terminal logo for a model · Adyen Get the Terminal Logo #
Ask an LLM
“What logo shows by default on a terminal model across my whole merchant account?”
“Can I retrieve the merchant-level logo for a terminal model?”
Tell an agent
Get the merchant-wide terminal logo for model {model} on {merchantId}.
Show the default {model} logo for all stores of merchant {merchantId}.
PATCH /merchants/{merchantId}/terminalLogos Change the merchant-wide terminal logo · Adyen Update the Terminal Logo #
Ask an LLM
“How do I set one logo for a terminal model across my entire merchant account?”
“Can I brand every terminal of a given model under my merchant at once?”
Tell an agent
Upload logo {data} for all {model} terminals under merchant {merchantId}.
Replace the merchant-level {model} terminal logo on {merchantId}.
GET /merchants/{merchantId}/terminalModels List terminal models a merchant can order · Adyen Get a List of Terminal Models #
Ask an LLM
“Which payment terminal models does my merchant account have access to?”
“Where do I get the terminal model ID needed to look up terminal products?”
Tell an agent
List the terminal models available to merchant {merchantId}.
Show which terminal hardware models {merchantId} can use.
GET /merchants/{merchantId}/terminalOrders List terminal hardware orders · Adyen Get a List of Orders #
Ask an LLM
“What terminal orders has my merchant placed so far?”
“Can I filter terminal orders by status or by my own order reference?”
Tell an agent
List terminal orders for merchant {merchantId}.
Show terminal orders of {merchantId} with status {status}.
POST /merchants/{merchantId}/terminalOrders Order payment terminal hardware · Adyen Create an Order #
Ask an LLM
“How do I order new card terminals for my merchant account?”
“Can I choose the billing entity and shipping address on a terminal order?”
Tell an agent
Place a terminal order for merchant {merchantId} with items {items} shipped to location {shippingLocationId}.
Order terminals for {merchantId} billed to {billingEntityId}.
GET /merchants/{merchantId}/terminalOrders/{orderId} Check one terminal order · Adyen Get an Order #
Ask an LLM
“What's the status of a specific terminal hardware order?”
“Which items are in one of my terminal orders?”
Tell an agent
Get terminal order {orderId} for merchant {merchantId}.
Show the status of terminal order {orderId} under {merchantId}.
PATCH /merchants/{merchantId}/terminalOrders/{orderId} Change a placed terminal order · Adyen Update an Order #
Ask an LLM
“Can I change the items on a terminal order before it ships?”
“When is it still possible to edit a terminal order?”
Tell an agent
Update terminal order {orderId} on {merchantId} to items {items}.
Change the shipping location of order {orderId} for merchant {merchantId} to {shippingLocationId}.
POST /merchants/{merchantId}/terminalOrders/{orderId}/cancel Cancel a terminal order · Adyen Cancel an Order #
Ask an LLM
“How do I cancel a terminal hardware order I placed by mistake?”
“Can a terminal order be cancelled after it leaves the Placed status?”
Tell an agent destructive · confirm first
Cancel terminal order {orderId} for merchant {merchantId}.
Call off the terminal hardware order {orderId} on {merchantId}.
GET /merchants/{merchantId}/terminalProducts Browse terminal products for a country · Adyen Get a List of Terminal Products #
Ask an LLM
“Which terminal packages and parts can I order in a given country?”
“Can I narrow the terminal product catalog to one model?”
Tell an agent
List terminal products for merchant {merchantId} in country {country}.
Show terminal packages for model {terminalModelId} in {country} for {merchantId}.
GET /merchants/{merchantId}/terminalSettings Get the merchant-wide terminal settings · Adyen Get Terminal Settings #
Ask an LLM
“What terminal settings apply by default to every terminal under my merchant?”
“Which offline processing and receipt options are set at merchant level?”
Tell an agent
Get the merchant-level terminal settings for {merchantId}.
Show default terminal configuration across all stores of merchant {merchantId}.
PATCH /merchants/{merchantId}/terminalSettings Update terminal settings for the whole merchant · Adyen Update Terminal Settings #
Ask an LLM
“How do I change the receipt printing options for every terminal on my merchant account?”
“Can I enable offline processing across all terminals under a merchant?”
Tell an agent
Set receipt printing to {receiptPrinting} for all terminals under merchant {merchantId}.
Update merchant-wide offline processing on {merchantId} to {offlineProcessing}.
GET /merchants/{merchantId}/users List users on a merchant account · Adyen Get a List of Users #
Ask an LLM
“Who has a user login on my merchant account?”
“Can I search a merchant's users by username?”
Tell an agent
List the users of merchant {merchantId}.
Find user {username} on merchant {merchantId}.
POST /merchants/{merchantId}/users Add a user to a merchant account · Adyen Create a New User #
Ask an LLM
“How do I give a colleague a login to my merchant account?”
“Can I assign roles and a time zone when creating a merchant user?”
Tell an agent
Create user {username} with email {email} and name {name} on merchant {merchantId}.
Invite {email} to {merchantId} as {username} named {name} with roles {roles}.
GET /merchants/{merchantId}/users/{userId} Get a merchant user's details · Adyen Get User Details #
Ask an LLM
“What roles does a particular user have on my merchant?”
“Is a specific merchant user still active?”
Tell an agent
Get user {userId} on merchant {merchantId}.
Show the roles and status of user {userId} for {merchantId}.
PATCH /merchants/{merchantId}/users/{userId} Update or deactivate a merchant user · Adyen Update a User #
Ask an LLM
“Can I switch off a merchant user's access without deleting them?”
“How do I change the email or roles of an existing merchant user?”
Tell an agent
Set user {userId} on merchant {merchantId} to active {active}.
Change the roles of user {userId} on {merchantId} to {roles}.
GET /merchants/{merchantId}/webhooks List a merchant's webhook configurations · Adyen List All Webhooks #
Ask an LLM
“Which webhooks are configured on my merchant account?”
“Where are my merchant's notifications currently being sent?”
Tell an agent
List webhook configurations for merchant {merchantId}.
Show page {pageNumber} of merchant {merchantId} webhooks.
POST /merchants/{merchantId}/webhooks Subscribe a URL to merchant webhooks · Adyen Set Up a Webhook #
Ask an LLM
“How do I start receiving payment event notifications for my merchant account?”
“Can I protect my merchant webhook endpoint with basic authentication?”
Tell an agent
Set up an active {type} webhook for merchant {merchantId} posting {communicationFormat} to {url}.
Create a merchant {merchantId} webhook to {url} with username {username} and password {password}, type {type}, format {communicationFormat}, active {active}.
DELETE /merchants/{merchantId}/webhooks/{webhookId} Remove a merchant webhook · Adyen Remove a Webhook #
Ask an LLM
“How do I stop a merchant webhook from receiving notifications altogether?”
“Can I delete a webhook configuration I set up on my merchant?”
Tell an agent destructive · confirm first
Remove webhook {webhookId} from merchant {merchantId}.
Delete the merchant {merchantId} webhook configuration {webhookId}.
GET /merchants/{merchantId}/webhooks/{webhookId} Get one merchant webhook's configuration · Adyen Get a Webhook #
Ask an LLM
“What URL and format is a specific merchant webhook using?”
“Is a particular webhook on my merchant active?”
Tell an agent
Get webhook {webhookId} on merchant {merchantId}.
Show the settings of merchant {merchantId} webhook {webhookId}.
PATCH /merchants/{merchantId}/webhooks/{webhookId} Change a merchant webhook's settings · Adyen Update a Webhook #
Ask an LLM
“Can I point an existing merchant webhook at a new URL?”
“How do I temporarily disable a merchant webhook without removing it?”
Tell an agent
Change the URL of webhook {webhookId} on merchant {merchantId} to {url}.
Set merchant {merchantId} webhook {webhookId} active to {active}.
POST /merchants/{merchantId}/webhooks/{webhookId}/generateHmac Generate an HMAC key for a merchant webhook · Adyen Generate an HMAC Key #
Ask an LLM
“How do I verify that notifications to my merchant webhook really came from Adyen?”
“Where do I get an HMAC signing key for a merchant webhook?”
Tell an agent
Generate an HMAC key for webhook {webhookId} on merchant {merchantId}.
Create a new signing key for merchant {merchantId} webhook {webhookId}.
POST /merchants/{merchantId}/webhooks/{webhookId}/test Send test notifications to a merchant webhook · Adyen Test a Webhook #
Ask an LLM
“Can I check my merchant webhook endpoint is set up correctly before going live?”
“What test notifications get sent when I test a merchant webhook?”
Tell an agent
Send test notifications to webhook {webhookId} on merchant {merchantId}.
Test merchant {merchantId} webhook {webhookId} with event types {types}.

Documentation

📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
📖
Documentation
https://docs.adyen.com/api-explorer/Account/6/overview
📖
Documentation
https://docs.adyen.com/development-resources/webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/BalanceControl/1/overview
📖
Documentation
https://docs.adyen.com/api-explorer/BinLookup/52/overview
📖
Documentation
https://docs.adyen.com/api-explorer/Checkout/71/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform/2/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/development-resources/data-protection-api/
📖
Documentation
https://docs.adyen.com/risk-management/disputes-api
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/fund-transfer/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/legal-entity-management-api/
📖
Documentation
https://docs.adyen.com/api-explorer/Management/3/overview
📖
Documentation
https://docs.adyen.com/api-explorer/management-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/notifications
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/notifications/
📖
Documentation
https://docs.adyen.com/online-payments/
📖
Documentation
https://docs.adyen.com/online-payments/online-payouts
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/
📖
Documentation
https://docs.adyen.com/online-payments/tokenization
📖
Documentation
https://docs.adyen.com/api-explorer/report-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/payment-methods/gift-cards/stored-value-api/
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/
📖
Documentation
https://docs.adyen.com/development-resources/testing/create-test-cards
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions/transaction-webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts
📖
Documentation
https://docs.adyen.com/development-resources/webhooks

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-merchants-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/asyncapi/adyen-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/adyen-merchants-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adyen-merchants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '3'
  x-publicVersion: true
  title: Adyen Management Merchants API
  description: Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://management-test.adyen.com/v3
tags:


# --- truncated at 32 KB (661 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-merchants-api-openapi.yml