{ "opencollection": "1.0.0", "info": { "name": "Adyen Account acceptDispute Merchants API", "version": "6" }, "items": [ { "info": { "name": "Merchants", "type": "folder" }, "items": [ { "info": { "name": "Adyen Get a List of Merchant Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read" }, { "info": { "name": "Adyen Create a Merchant Account", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a merchant account for the company account specified in the request.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Accounts read and write" }, { "info": { "name": "Adyen Get a Merchant Account", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Account read" }, { "info": { "name": "Adyen Request to Activate a Merchant Account", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/activate", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends a request to activate the merchant account identified in the path.\n\nYou get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this requ" }, { "info": { "name": "Adyen Get a List of API Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Create an API Credential", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential.\n\nThe response includes the:\n* [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication.\n* [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): publ" }, { "info": { "name": "Adyen Get an API Credential", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Update an API Credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. \n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get a List of Allowed Origins", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Create an Allowed Origin", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get an Allowed Origin", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." }, { "name": "originId", "value": "", "type": "path", "description": "Unique identifier of the allowed origin." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Delete an Allowed Origin", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." }, { "name": "originId", "value": "", "type": "path", "description": "Unique identifier of the allowed origin." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Generate New API Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Generate New Client Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "apiCredentialId", "value": "", "type": "path", "description": "Unique identifier of the API credential." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write" }, { "info": { "name": "Adyen Get a List of Billing Entities", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/billingEntities", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "name", "value": "", "type": "query", "description": "The name of the billing entity." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the billing entities of the merchant account identified in the path.\nA billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get All Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "storeId", "value": "", "type": "query", "description": "The unique identifier of the store for which to return the payment methods." }, { "name": "businessLineId", "value": "", "type": "query", "description": "The unique identifier of the Business Line for which to return the payment methods." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns details for all payment methods of the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n" }, { "info": { "name": "Adyen Request a Payment Method", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends a request to add a new payment method to the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n" }, { "info": { "name": "Adyen Get Payment Method Details", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "paymentMethodId", "value": "", "type": "path", "description": "The unique identifier of the payment method." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n" }, { "info": { "name": "Adyen Update a Payment Method", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings/:paymentMethodId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "paymentMethodId", "value": "", "type": "path", "description": "The unique identifier of the payment method." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates payment method details for the merchant account and the payment method identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n" }, { "info": { "name": "Adyen Add an Apple Pay Domain", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "paymentMethodId", "value": "", "type": "path", "description": "The unique identifier of the payment method." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read and write\n" }, { "info": { "name": "Adyen Get Apple Pay Domains", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "paymentMethodId", "value": "", "type": "path", "description": "The unique identifier of the payment method." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain).\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payment methods read\n" }, { "info": { "name": "Adyen Get a List of Payout Settings", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/payoutSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of payout settings for the merchant account identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read" }, { "info": { "name": "Adyen Add a Payout Setting", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/payoutSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting.\n\nIf you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account.\n\nUse" }, { "info": { "name": "Adyen Get a Payout Setting", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/payoutSettings/:payoutSettingsId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "payoutSettingsId", "value": "", "type": "path", "description": "The unique identifier of the payout setting." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Payout account settings read" }, { "info": { "name": "Adyen Update a Payout Setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/payoutSettings/:payoutSettingsId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "payoutSettingsId", "value": "", "type": "path", "description": "The unique identifier of the payout setting." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the payout setting identified in the path. You can enable or disable the payout setting.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write" }, { "info": { "name": "Adyen Delete a Payout Setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/payoutSettings/:payoutSettingsId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "payoutSettingsId", "value": "", "type": "path", "description": "The unique identifier of the payout setting." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the payout setting identified in the path.\n\nUse this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\n* Management API—Payout account settings read and write" }, { "info": { "name": "Adyen Get a List of Shipping Locations", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/shippingLocations", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "name", "value": "", "type": "query", "description": "The name of the shipping location." }, { "name": "offset", "value": "", "type": "query", "description": "The number of locations to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of locations to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the shipping locations for the merchant account identified in the path.\nA shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Create a Shipping Location", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/shippingLocations", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. \n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Split Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of split configurations for the merchant account.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Create a Split Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a split configuration for the merchant account specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Get a Split Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Create a Rule", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a rule in the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Update Split Configuration Description", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Changes the description of the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Delete a Split Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the split configuration specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Update Split Conditions", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The identifier of the split configuration." }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the split configuration rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Changes the conditions of the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Delete a Split Configuration Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." }, { "name": "ruleId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the split configuration rule specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Update the Split Logic", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "splitConfigurationId", "value": "", "type": "path", "description": "The unique identifier of the split configuration." }, { "name": "ruleId", "value": "", "type": "path", "description": "The unique identifier of the split configuration rule." }, { "name": "splitLogicId", "value": "", "type": "path", "description": "The unique identifier of the split configuration split." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Changes the split logic specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API - SplitConfiguration read and write" }, { "info": { "name": "Adyen Get a List of Stores", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." }, { "name": "reference", "value": "", "type": "query", "description": "The reference of the store." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write" }, { "info": { "name": "Adyen Create a Store", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a store for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write" }, { "info": { "name": "Adyen Get the Terminal Logo", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:reference/terminalLogos", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "reference", "value": "", "type": "path", "description": "The reference that identifies the store." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api" }, { "info": { "name": "Adyen Update the Terminal Logo", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:reference/terminalLogos", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "reference", "value": "", "type": "path", "description": "The reference that identifies the store." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time.\nThis logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. \n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value" }, { "info": { "name": "Adyen Get Terminal Settings", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:reference/terminalSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "reference", "value": "", "type": "path", "description": "The reference that identifies the store." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read and write\n\nFor [sensitive terminal setting" }, { "info": { "name": "Adyen Update Terminal Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:reference/terminalSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "reference", "value": "", "type": "path", "description": "The reference that identifies the store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal.\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the paramete" }, { "info": { "name": "Adyen Get a Store", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:storeId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "storeId", "value": "", "type": "path", "description": "The unique identifier of the store." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of the store identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read\n* Management API—Stores read and write" }, { "info": { "name": "Adyen Update a Store", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/stores/:storeId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "storeId", "value": "", "type": "path", "description": "The unique identifier of the store." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the store identified in the path. You can only update some store parameters.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Stores read and write" }, { "info": { "name": "Adyen Get the Terminal Logo", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalLogos", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Possible values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. \nThe logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https" }, { "info": { "name": "Adyen Update the Terminal Logo", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalLogos", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "model", "value": "", "type": "query", "description": "The terminal model. Allowed values: E355, VX675WIFIBT, VX680, VX690, VX700, VX820, M400, MX925, P400Plus, UX300, UX410, V200cPlus, V240mPlus, V400cPlus, V400m, e280, e285, e285p, S1E, S1EL, S1F2, S1L, S1U, S7T." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. \nThis logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal).\n\n* To change the logo, specify the image file as a Base64-encoded string.\n* To restore the logo inherited from the company account, specify an empty logo value." }, { "info": { "name": "Adyen Get a List of Terminal Models", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalModels", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalOrders", "params": [ { "name": "merchantId", "value": "", "type": "path" }, { "name": "customerOrderReference", "value": "", "type": "query", "description": "Your purchase order number." }, { "name": "status", "value": "", "type": "query", "description": "The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered." }, { "name": "offset", "value": "", "type": "query", "description": "The number of orders to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of orders to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of terminal products orders for the merchant account identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Create an Order", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalOrders", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates an order for payment terminal products for the merchant account identified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write\n>Requests to the Management API test endpoint do not create actual orders for test terminals. To order test terminals, you need to [submit a sales order](https://docs.adyen.com/point-of-sale/managing-t" }, { "info": { "name": "Adyen Get an Order", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalOrders/:orderId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of the terminal products order identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Update an Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalOrders/:orderId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the terminal products order identified in the path.\nUpdating is only possible while the order has the status **Placed**.\n\nThe request body only needs to contain what you want to change. \nHowever, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items:\n To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items.\n\nTo make this request, your API credential mu" }, { "info": { "name": "Adyen Cancel an Order", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalOrders/:orderId/cancel", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "orderId", "value": "", "type": "path", "description": "The unique identifier of the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Cancels the terminal products order identified in the path.\nCancelling is only possible while the order has the status **Placed**.\nTo cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get a List of Terminal Products", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalProducts", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "country", "value": "", "type": "query", "description": "The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**" }, { "name": "terminalModelId", "value": "", "type": "query", "description": "The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400**" }, { "name": "offset", "value": "", "type": "query", "description": "The number of products to skip." }, { "name": "limit", "value": "", "type": "query", "description": "The number of products to return." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal ordering read\n* Management API—Terminal ordering read and write" }, { "info": { "name": "Adyen Get Terminal Settings", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal).\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Terminal settings read\n* Management API—Terminal settings read" }, { "info": { "name": "Adyen Update Terminal Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/terminalSettings", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates payment terminal settings for the merchant account identified in the path.\nThese settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal).\n\n* To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object.\n* To restore a parameter value inherited from a higher level, include the full object that contains the parameter, " }, { "info": { "name": "Adyen Get a List of Users", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/users", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "Unique identifier of the merchant." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page." }, { "name": "username", "value": "", "type": "query", "description": "The partial or complete username to select all users that match." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of users associated with the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Create a New User", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/users", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "Unique identifier of the merchant." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a user for the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Get User Details", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/users/:userId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "Unique identifier of the merchant." }, { "name": "userId", "value": "", "type": "path", "description": "Unique identifier of the user." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen Update a User", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/users/:userId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "Unique identifier of the merchant." }, { "name": "userId", "value": "", "type": "path", "description": "Unique identifier of the user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates user details for the `userId` and the `merchantId` specified in the path.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Users read and write\n" }, { "info": { "name": "Adyen List All Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The number of the page to fetch." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to have on a page, maximum 100. The default is 10 items on a page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all webhook configurations for the merchant account.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Set Up a Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Get a Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks/:webhookId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Update a Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks/:webhookId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Remove a Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks/:webhookId", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Remove the configuration for the webhook identified in the path.\n\nTo make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—Webhooks read and write" }, { "info": { "name": "Adyen Generate an HMAC Key", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks/:webhookId/generateHmac", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "webhookId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatu" }, { "info": { "name": "Adyen Test a Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://cal-test.adyen.com/cal/services/Account/v6/merchants/:merchantId/webhooks/:webhookId/test", "params": [ { "name": "merchantId", "value": "", "type": "path", "description": "The unique identifier of the merchant account." }, { "name": "webhookId", "value": "", "type": "path", "description": "Unique identifier of the webhook configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Sends sample notifications to test if the webhook is set up correctly.\n\nWe send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.\n\nThe response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields" } ] } ], "bundled": true }