Adyen · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adyen Management Merchants API
68 actions
68 updates
phrasing
extends
openapi/adyen-merchants-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Adyen's API. It is a proposal applied on top of the contract, not a document Adyen publishes.
What the actions change
x-apievangelist-phrasing
Targets 68 · first 16 shown; the file carries all of them
$.info
$.paths['/merchants'].get
$.paths['/merchants'].post
$.paths['/merchants/{merchantId}'].get
$.paths['/merchants/{merchantId}/activate'].post
$.paths['/merchants/{merchantId}/apiCredentials'].get
$.paths['/merchants/{merchantId}/apiCredentials'].post
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}'].get
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}'].patch
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins'].get
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins'].post
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].get
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].delete
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey'].post
$.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey'].post
$.paths['/merchants/{merchantId}/billingEntities'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Adyen Management Merchants API
version: 1.0.0
extends: openapi/adyen-merchants-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 67
- target: $.paths['/merchants'].get
update:
x-apievangelist-phrasing:
intent: List the merchant accounts I can access
effect: read
questions:
- Which Adyen merchant accounts can my API credential see?
- Can I page through all my merchant accounts 100 at a time?
instructions:
- text: List every merchant account my credential has access to.
- text: Show page {pageNumber} of my merchant accounts with {pageSize} per page.
slots:
pageNumber: query.pageNumber
pageSize: query.pageSize
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants'].post
update:
x-apievangelist-phrasing:
intent: Create a new merchant account under a company
effect: write
questions:
- 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?
instructions:
- text: Create a merchant account under company {companyId}.
slots:
companyId: requestBody.companyId
- text: Create a merchant account for company {companyId} tied to legal entity {legalEntityId} with reference {reference}.
slots:
companyId: requestBody.companyId
legalEntityId: requestBody.legalEntityId
reference: requestBody.reference
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}'].get
update:
x-apievangelist-phrasing:
intent: Look up one merchant account
effect: read
questions:
- What details are stored on a specific merchant account?
- Can I check the status of a single merchant account by its ID?
instructions:
- text: Get the details of merchant account {merchantId}.
slots:
merchantId: path.merchantId
- text: Show me merchant {merchantId}.
slots:
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/activate'].post
update:
x-apievangelist-phrasing:
intent: Request activation of a merchant account
effect: write
questions:
- How do I get a newly created merchant account activated?
- Where do I find out whether a merchant activation request succeeded?
instructions:
- text: Request activation for merchant account {merchantId}.
slots:
merchantId: path.merchantId
- text: Send the activation request for {merchantId} so it can start processing.
slots:
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials'].get
update:
x-apievangelist-phrasing:
intent: List a merchant account's API credentials
effect: read
questions:
- Which API credentials exist on my merchant account?
- Can I see all the API users set up for one merchant?
instructions:
- text: List the API credentials on merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Show page {pageNumber} of API credentials for merchant {merchantId}.
slots:
pageNumber: query.pageNumber
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials'].post
update:
x-apievangelist-phrasing:
intent: Create an API credential for a merchant
effect: write
questions:
- 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?
instructions:
- text: Create a new API credential on merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Create an API credential for merchant {merchantId} with roles {roles} and allowed origins {allowedOrigins}.
slots:
merchantId: path.merchantId
roles: requestBody.roles
allowedOrigins: requestBody.allowedOrigins
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}'].get
update:
x-apievangelist-phrasing:
intent: Get one merchant API credential
effect: read
questions:
- What roles does a particular merchant API credential have?
- Is a given API credential on my merchant still active?
instructions:
- text: Get API credential {apiCredentialId} on merchant {merchantId}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Show the roles and origins of credential {apiCredentialId} for merchant {merchantId}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}'].patch
update:
x-apievangelist-phrasing:
intent: Change a merchant API credential's roles or origins
effect: write
questions:
- Can I change the roles on an existing merchant API credential?
- How do I deactivate a merchant API credential without deleting it?
instructions:
- text: Update the roles of credential {apiCredentialId} on merchant {merchantId} to {roles}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
roles: requestBody.roles
- text: Set credential {apiCredentialId} on merchant {merchantId} to active {active}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
active: requestBody.active
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins'].get
update:
x-apievangelist-phrasing:
intent: List allowed origins for a merchant credential
effect: read
questions:
- Which domains are allowed to make client-side calls with my merchant credential?
- What allowed origins are configured on a merchant API credential?
instructions:
- text: List the allowed origins of credential {apiCredentialId} on merchant {merchantId}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Show every domain whitelisted for merchant {merchantId} credential {apiCredentialId}.
slots:
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins'].post
update:
x-apievangelist-phrasing:
intent: Add an allowed origin to a merchant credential
effect: write
questions:
- 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?
instructions:
- text: Add {domain} as an allowed origin on credential {apiCredentialId} for merchant {merchantId}.
slots:
domain: requestBody.domain
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Allow client-side requests from {domain} for merchant {merchantId} credential {apiCredentialId}.
slots:
domain: requestBody.domain
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].get
update:
x-apievangelist-phrasing:
intent: Get one allowed origin on a merchant credential
effect: read
questions:
- 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?
instructions:
- text: Get allowed origin {originId} on credential {apiCredentialId} for merchant {merchantId}.
slots:
originId: path.originId
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Show origin {originId} of merchant {merchantId} credential {apiCredentialId}.
slots:
originId: path.originId
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove an allowed origin from a merchant credential
effect: destructive
questions:
- How do I stop a domain from making client-side requests with my merchant credential?
- What happens right after I remove an allowed origin?
instructions:
- text: Delete allowed origin {originId} from credential {apiCredentialId} on merchant {merchantId}.
slots:
originId: path.originId
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Revoke origin {originId} for merchant {merchantId} credential {apiCredentialId}.
slots:
originId: path.originId
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey'].post
update:
x-apievangelist-phrasing:
intent: Rotate the API key of a merchant credential
effect: write
questions:
- 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?
instructions:
- text: Generate a new API key for credential {apiCredentialId} on merchant {merchantId}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Rotate the server API key of merchant {merchantId} credential {apiCredentialId}.
slots:
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey'].post
update:
x-apievangelist-phrasing:
intent: Rotate the client key of a merchant credential
effect: write
questions:
- Can I issue a fresh client key for my merchant's checkout front end?
- When does the previous client key stop working after rotation?
instructions:
- text: Generate a new client key for credential {apiCredentialId} on merchant {merchantId}.
slots:
apiCredentialId: path.apiCredentialId
merchantId: path.merchantId
- text: Rotate the client-side key of merchant {merchantId} credential {apiCredentialId}.
slots:
merchantId: path.merchantId
apiCredentialId: path.apiCredentialId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/billingEntities'].get
update:
x-apievangelist-phrasing:
intent: List billing entities for terminal orders
effect: read
questions:
- Which legal entities can terminal orders for my merchant be billed to?
- Can I search a merchant's billing entities by name?
instructions:
- text: List the billing entities of merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Find billing entities named {name} for merchant {merchantId}.
slots:
name: query.name
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings'].get
update:
x-apievangelist-phrasing:
intent: List payment methods enabled on a merchant
effect: read
questions:
- Which payment methods are configured on my merchant account?
- Can I filter a merchant's payment methods down to one store?
instructions:
- text: List all payment methods for merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Show the payment methods of merchant {merchantId} for store {storeId}.
slots:
merchantId: path.merchantId
storeId: query.storeId
- text: List merchant {merchantId} payment methods in business line {businessLineId}.
slots:
merchantId: path.merchantId
businessLineId: query.businessLineId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings'].post
update:
x-apievangelist-phrasing:
intent: Request a new payment method for a merchant
effect: write
questions:
- 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?
instructions:
- text: Request payment method type {type} for merchant {merchantId}.
slots:
type: requestBody.type
merchantId: path.merchantId
- text: Request {type} on merchant {merchantId} for countries {countries} and currencies {currencies}.
slots:
type: requestBody.type
merchantId: path.merchantId
countries: requestBody.countries
currencies: requestBody.currencies
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}'].get
update:
x-apievangelist-phrasing:
intent: Get one payment method's settings
effect: read
questions:
- What countries and currencies does a specific payment method on my merchant support?
- Is a particular payment method enabled on my merchant account?
instructions:
- text: Get payment method {paymentMethodId} on merchant {merchantId}.
slots:
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
- text: Show the configuration of payment method {paymentMethodId} for {merchantId}.
slots:
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}'].patch
update:
x-apievangelist-phrasing:
intent: Update or disable an existing payment method
effect: write
questions:
- 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?
instructions:
- text: Set payment method {paymentMethodId} on merchant {merchantId} to enabled {enabled}.
slots:
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
enabled: requestBody.enabled
- text: Limit payment method {paymentMethodId} of merchant {merchantId} to stores {storeIds}.
slots:
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
storeIds: requestBody.storeIds
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains'].post
update:
x-apievangelist-phrasing:
intent: Register an Apple Pay domain
effect: write
questions:
- How do I register my website domain for Apple Pay on Adyen?
- Can I add several Apple Pay domains at once?
instructions:
- text: Add Apple Pay domains {domains} to payment method {paymentMethodId} on merchant {merchantId}.
slots:
domains: requestBody.domains
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
- text: Register {domains} for Apple Pay under merchant {merchantId} method {paymentMethodId}.
slots:
domains: requestBody.domains
merchantId: path.merchantId
paymentMethodId: path.paymentMethodId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains'].get
update:
x-apievangelist-phrasing:
intent: List registered Apple Pay domains
effect: read
questions:
- Which domains are already registered for Apple Pay on my merchant?
- Is my checkout domain on the Apple Pay domain list yet?
instructions:
- text: List the Apple Pay domains on payment method {paymentMethodId} for merchant {merchantId}.
slots:
paymentMethodId: path.paymentMethodId
merchantId: path.merchantId
- text: Show registered Apple Pay domains for merchant {merchantId} method {paymentMethodId}.
slots:
merchantId: path.merchantId
paymentMethodId: path.paymentMethodId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/payoutSettings'].get
update:
x-apievangelist-phrasing:
intent: List a merchant's payout settings
effect: read
questions:
- Where do payouts from my merchant account get sent?
- Which transfer instruments are linked to my merchant for payouts?
instructions:
- text: List the payout settings for merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Show all payout destinations configured on {merchantId}.
slots:
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/payoutSettings'].post
update:
x-apievangelist-phrasing:
intent: Link a transfer instrument for payouts
effect: write
questions:
- 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?
instructions:
- text: Add a payout setting on merchant {merchantId} using transfer instrument {transferInstrumentId}.
slots:
merchantId: path.merchantId
transferInstrumentId: requestBody.transferInstrumentId
- text: Pay out merchant {merchantId} to instrument {transferInstrumentId} starting {enabledFromDate}.
slots:
merchantId: path.merchantId
transferInstrumentId: requestBody.transferInstrumentId
enabledFromDate: requestBody.enabledFromDate
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/payoutSettings/{payoutSettingsId}'].get
update:
x-apievangelist-phrasing:
intent: Get one payout setting
effect: read
questions:
- Is a specific payout setting on my merchant enabled?
- Which transfer instrument does a given payout setting use?
instructions:
- text: Get payout setting {payoutSettingsId} for merchant {merchantId}.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
- text: Show the details of payout setting {payoutSettingsId} on {merchantId}.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/payoutSettings/{payoutSettingsId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a payout setting
effect: destructive
questions:
- How do I remove a payout destination from my merchant account entirely?
- Can I delete a payout setting I no longer need?
instructions:
- text: Delete payout setting {payoutSettingsId} from merchant {merchantId}.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
- text: Remove the payout setting {payoutSettingsId} on {merchantId} permanently.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/payoutSettings/{payoutSettingsId}'].patch
update:
x-apievangelist-phrasing:
intent: Enable or disable a payout setting
effect: write
questions:
- Can I pause payouts to one bank account without deleting the setting?
- How do I turn a disabled payout setting back on?
instructions:
- text: Set payout setting {payoutSettingsId} on merchant {merchantId} to enabled {enabled}.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
enabled: requestBody.enabled
- text: Disable payout setting {payoutSettingsId} for {merchantId}.
slots:
payoutSettingsId: path.payoutSettingsId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/shippingLocations'].get
update:
x-apievangelist-phrasing:
intent: List shipping locations for terminal orders
effect: read
questions:
- Which addresses can my terminal orders be shipped to?
- Can I search my merchant's shipping locations by name?
instructions:
- text: List shipping locations for merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Find the shipping location called {name} on merchant {merchantId}.
slots:
name: query.name
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/shippingLocations'].post
update:
x-apievangelist-phrasing:
intent: Add a shipping address for terminal orders
effect: write
questions:
- How do I add a new delivery address for terminal hardware orders?
- Can I include a contact person on a shipping location?
instructions:
- text: Create shipping location {name} for merchant {merchantId} at {address}.
slots:
name: requestBody.name
merchantId: path.merchantId
address: requestBody.address
- text: Add a shipping location on {merchantId} with contact {contact}.
slots:
merchantId: path.merchantId
contact: requestBody.contact
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations'].get
update:
x-apievangelist-phrasing:
intent: List a merchant's split configurations
effect: read
questions:
- Which split configuration profiles exist on my merchant account?
- What split configurations can I assign to my stores?
instructions:
- text: List split configurations for merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Show every split profile set up on {merchantId}.
slots:
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations'].post
update:
x-apievangelist-phrasing:
intent: Create a split configuration profile
effect: write
questions:
- 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?
instructions:
- text: Create a split configuration on merchant {merchantId} described as {description} with rules {rules}.
slots:
merchantId: path.merchantId
description: requestBody.description
rules: requestBody.rules
- text: Create split profile {description} on {merchantId} for stores {stores} using rules {rules}.
slots:
description: requestBody.description
merchantId: path.merchantId
stores: requestBody.stores
rules: requestBody.rules
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}'].get
update:
x-apievangelist-phrasing:
intent: Get one split configuration
effect: read
questions:
- What rules are inside a specific split configuration?
- Can I inspect one split profile by its ID?
instructions:
- text: Get split configuration {splitConfigurationId} on merchant {merchantId}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
- text: Show the rules of split profile {splitConfigurationId} for {merchantId}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}'].post
update:
x-apievangelist-phrasing:
intent: Add a rule to a split configuration
effect: write
questions:
- 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?
instructions:
- text: 'Add a split rule to {splitConfigurationId} on {merchantId}: {paymentMethod}, {currency}, {shopperInteraction}, logic {splitLogic}.'
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
paymentMethod: requestBody.paymentMethod
currency: requestBody.currency
shopperInteraction: requestBody.shopperInteraction
splitLogic: requestBody.splitLogic
- text: Create a new split rule in profile {splitConfigurationId} of merchant {merchantId}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a whole split configuration
effect: destructive
questions:
- How do I delete an entire split configuration profile?
- Can I remove a split profile I no longer use from my merchant?
instructions:
- text: Delete split configuration {splitConfigurationId} from merchant {merchantId}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
- text: Remove the whole split profile {splitConfigurationId} on {merchantId}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}'].patch
update:
x-apievangelist-phrasing:
intent: Rename a split configuration's description
effect: write
questions:
- Can I change the description of an existing split configuration?
- Is it possible to relabel a split profile without touching its rules?
instructions:
- text: Change the description of split configuration {splitConfigurationId} on {merchantId} to {description}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
description: requestBody.description
- text: Relabel split profile {splitConfigurationId} of merchant {merchantId} as {description}.
slots:
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one rule from a split configuration
effect: destructive
questions:
- 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?
instructions:
- text: Delete rule {ruleId} from split configuration {splitConfigurationId} on {merchantId}.
slots:
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
- text: Remove split rule {ruleId} in profile {splitConfigurationId} of merchant {merchantId}.
slots:
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}'].patch
update:
x-apievangelist-phrasing:
intent: Change the conditions of a split rule
effect: write
questions:
- 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?
instructions:
- text: Update rule {ruleId} in split configuration {splitConfigurationId} on {merchantId} to match {paymentMethod} in {currency} for {shopperInteraction}.
slots:
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
paymentMethod: requestBody.paymentMethod
currency: requestBody.currency
shopperInteraction: requestBody.shopperInteraction
- text: Restrict split rule {ruleId} of profile {splitConfigurationId} for {merchantId} to funding source {fundingSource}.
slots:
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
fundingSource: requestBody.fundingSource
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}'].patch
update:
x-apievangelist-phrasing:
intent: Change how a split rule divides funds and fees
effect: write
questions:
- 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?
instructions:
- text: Set the commission on split logic {splitLogicId} of rule {ruleId} in profile {splitConfigurationId} for {merchantId} to {commission}.
slots:
splitLogicId: path.splitLogicId
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
commission: requestBody.commission
- text: Allocate chargebacks as {chargeback} in split logic {splitLogicId}, rule {ruleId}, profile {splitConfigurationId}, merchant {merchantId}.
slots:
chargeback: requestBody.chargeback
splitLogicId: path.splitLogicId
ruleId: path.ruleId
splitConfigurationId: path.splitConfigurationId
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
- target: $.paths['/merchants/{merchantId}/stores'].get
update:
x-apievangelist-phrasing:
intent: List a merchant's stores
effect: read
questions:
- Which stores are set up under my merchant account?
- Can I find a store under my merchant by its reference?
instructions:
- text: List the stores of merchant {merchantId}.
slots:
merchantId: path.merchantId
- text: Find the store with reference {reference} under merchant {merchantId}.
slots:
reference: query.reference
merchantId: path.merchantId
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/overlays/adyen-merchants-api-phrasing-overlay.yaml