Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. ## Authentication Each request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Ar
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://management-test.adyen.com/v1 https://balanceplatform-api-test.adyen.com/bcl/v2 https://kyc-test.adyen.com/lem/v3 https://checkout-test.adyen.com/v70 https://cal-test.adyen.com/cal/services/Account/v6 https://pal-test.adyen.com/pal/servlet/Payment/v68
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. ## Authentication Each request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value. To access the live endpoints, you need to
| method | path | what the vendor says it does |
|---|---|---|
GET | /companies | Get a list of company accounts Returns the list of company accounts that your API credential has access to. Th |
GET | /companies/{companyId} | Get a company account Returns the company account specified in the path. Your API credential must have access |
GET | /companies/{companyId}/androidApps | Get a list of Android apps Returns a list of the Android apps that are available for the company identified in |
GET | /companies/{companyId}/androidCertificates | Get a list of Android certificates Returns a list of the Android certificates that are available for the compa |
GET | /companies/{companyId}/apiCredentials | Get a list of API credentials Returns the list of [API credentials](https://docs.adyen.com/development-resourc |
POST | /companies/{companyId}/apiCredentials | Create an API credential. Creates an [API credential](https://docs.adyen.com/development-resources/api-credent |
GET | /companies/{companyId}/apiCredentials/{apiCredentialId} | Get an API credential Returns the [API credential](https://docs.adyen.com/development-resources/api-credential |
PATCH | /companies/{companyId}/apiCredentials/{apiCredentialId} | Update an API credential. Changes the API credential's roles, merchant account access, or allowed origins. The |
GET | /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins | Get a list of allowed origins Returns the list of [allowed origins](https://docs.adyen.com/development-resourc |
POST | /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins | Create an allowed origin Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side- |
GET | /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} | Get an allowed origin Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-au |
DELETE | /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} | Delete an allowed origin Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side |
POST | /companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey | Generate new API key Returns a new API key for the API credential. You can use the new API key a few minutes a |
POST | /companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey | Generate new client key Returns a new [client key](https://docs.adyen.com/development-resources/client-side-au |
GET | /companies/{companyId}/billingEntities | Get a list of billing entities Returns the billing entities of the company identified in the path and all merc |
GET | /companies/{companyId}/merchants | Get a list of merchant accounts Returns the list of merchant accounts under the company account specified in t |
GET | /companies/{companyId}/shippingLocations | Get a list of shipping locations Returns the shipping locations for the company identified in the path and all |
POST | /companies/{companyId}/shippingLocations | Create a shipping location Creates a shipping location for the company identified in the path. A shipping loca |
GET | /companies/{companyId}/terminalActions | Get a list of terminal actions Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating- |
GET | /companies/{companyId}/terminalActions/{actionId} | Get terminal action Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automati |
GET | /companies/{companyId}/terminalLogos | Get the terminal logo Returns the logo that is configured for a specific payment terminal model at the company |
PATCH | /companies/{companyId}/terminalLogos | Update the terminal logo Updates the logo that is configured for a specific payment terminal model at the comp |
GET | /companies/{companyId}/terminalModels | Get a list of terminal models Returns a list of payment terminal models that the company identified in the pat |
GET | /companies/{companyId}/terminalOrders | Get a list of orders Returns a lists of terminal products orders for the company identified in the path. To fi |
POST | /companies/{companyId}/terminalOrders | Create an order Creates an order for payment terminal products for the company identified in the path. To mak |
GET | /companies/{companyId}/terminalOrders/{orderId} | Get an order Returns the details of the terminal products order identified in the path. To make this request, |
PATCH | /companies/{companyId}/terminalOrders/{orderId} | Update an order Updates the terminal products order identified in the path. Updating is only possible while th |
POST | /companies/{companyId}/terminalOrders/{orderId}/cancel | Cancel an order Cancels the terminal products order identified in the path. Cancelling is only possible while |
GET | /companies/{companyId}/terminalProducts | Get a list of terminal products Returns a country-specific list of payment terminal packages and parts that th |
GET | /companies/{companyId}/terminalSettings | Get terminal settings Returns the payment terminal settings that are configured for the company identified in |
PATCH | /companies/{companyId}/terminalSettings | Update terminal settings Updates payment terminal settings for the company identified in the path. These setti |
GET | /companies/{companyId}/users | Get a list of users Returns the list of users for the `companyId` identified in the path. To make this reques |
POST | /companies/{companyId}/users | Create a new user Creates the user for the `companyId` identified in the path. To make this request, your API |
GET | /companies/{companyId}/users/{userId} | Get user details Returns user details for the `userId` and the `companyId` identified in the path. To make th |
PATCH | /companies/{companyId}/users/{userId} | Update user details Updates user details for the `userId` and the `companyId` identified in the path. To make |
GET | /companies/{companyId}/webhooks | List all webhooks Lists all webhook configurations for the company account. To make this request, your API cr |
POST | /companies/{companyId}/webhooks | Set up a webhook Subscribe to receive webhook notifications about events related to your company account. You |
GET | /companies/{companyId}/webhooks/{webhookId} | Get a webhook Returns the configuration for the webhook identified in the path. To make this request, your AP |
PATCH | /companies/{companyId}/webhooks/{webhookId} | Update a webhook Make changes to the configuration of the webhook identified in the path. The request contains |
DELETE | /companies/{companyId}/webhooks/{webhookId} | Remove a webhook Remove the configuration for the webhook identified in the path. To make this request, your |
and 79 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/ManagementService-v1.json
The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. ## Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H "Content-Type: application/json" \ -H "X
| method | path | what the vendor says it does |
|---|---|---|
POST | /accountHolders | Create an account holder Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explo |
GET | /accountHolders/{id} | Get an account holder Returns an account holder. Account holders |
PATCH | /accountHolders/{id} | Update an account holder Updates an account holder. When updating an account holder resource, if a parameter i |
GET | /accountHolders/{id}/balanceAccounts | Get all balance accounts of an account holder Returns a paginated list of the balance accounts associated with |
POST | /balanceAccounts | Create a balance account Creates a balance account that holds the funds of the associated account holder. Bala |
GET | /balanceAccounts/{balanceAccountId}/sweeps | Get all sweeps for a balance account Returns a list of the sweeps configured for a balance account. To fetch |
POST | /balanceAccounts/{balanceAccountId}/sweeps | Create a sweep Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or |
GET | /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} | Get a sweep Returns a sweep. Balance accounts |
PATCH | /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} | Update a sweep Updates a sweep. When updating a sweep resource, note that if a request parameter is not provid |
DELETE | /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} | Delete a sweep Deletes a sweep for a balance account. Balance accounts |
GET | /balanceAccounts/{id} | Get a balance account Returns a balance account and its balances for the default currency and other currencies |
PATCH | /balanceAccounts/{id} | Update a balance account Updates a balance account. Balance accounts |
GET | /balanceAccounts/{id}/paymentInstruments | Get all payment instruments for a balance account Returns a paginated list of the payment instruments associat |
GET | /balancePlatforms/{id} | Get a balance platform Returns a balance platform. Platform |
GET | /balancePlatforms/{id}/accountHolders | Get all account holders under a balance platform Returns a paginated list of all the account holders that belo |
GET | /grantAccounts/{id} | Get a grant account Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platfor |
GET | /grantOffers | Get all available grant offers Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-pl |
GET | /grantOffers/{grantOfferId} | Get a grant offer Returns the details of a single grant offer. Grant offers |
POST | /paymentInstrumentGroups | Create a payment instrument group Creates a payment instrument group to associate and group payment instrument |
GET | /paymentInstrumentGroups/{id} | Get a payment instrument group Returns the details of a payment instrument group. Payment instrument groups |
GET | /paymentInstrumentGroups/{id}/transactionRules | Get all transaction rules for a payment instrument group Returns a list of all the transaction rules associate |
POST | /paymentInstruments | Create a payment instrument Creates a payment instrument to issue a physical card, a virtual card, or a busine |
GET | /paymentInstruments/{id} | Get a payment instrument Returns the details of a payment instrument. Payment instruments |
PATCH | /paymentInstruments/{id} | Update a payment instrument Updates a payment instrument. Once a payment instrument is already active, you can |
GET | /paymentInstruments/{id}/reveal | Get the PAN of a payment instrument Returns the primary account number (PAN) of a payment instrument. To make |
GET | /paymentInstruments/{id}/transactionRules | Get all transaction rules for a payment instrument Returns a list of transaction rules associated with a payme |
POST | /transactionRules | Create a transaction rule Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When |
GET | /transactionRules/{transactionRuleId} | Get a transaction rule Returns the details of a transaction rule. Transaction rules |
PATCH | /transactionRules/{transactionRuleId} | Update a transaction rule Updates a transaction rule. * To update only the status of a transaction rule, sen |
DELETE | /transactionRules/{transactionRuleId} | Delete a transaction rule Deletes a transaction rule. Transaction rules |
POST | /validateBankAccountIdentification | Validate a bank account Validates bank account identification details. You can use this endpoint to validate b |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/BalancePlatformService-v2.
The Legal Entity Management API enables you to manage legal entities that contain information required for verification. ## Authentication To connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentia
| method | path | what the vendor says it does |
|---|---|---|
POST | /businessLines | Create a business line Creates a business line. This resource contains information about your user's line of |
GET | /businessLines/{id} | Get a business line Returns the detail of a business line. Business lines |
PATCH | /businessLines/{id} | Update a business line Updates a business line. Business lines |
DELETE | /businessLines/{id} | Delete a business line Deletes a business line. >If you delete a business line linked to a [payment method]( |
POST | /documents | Upload a document for verification checks Uploads a document for verification checks. Adyen uses the informa |
GET | /documents/{id} | Get a document Returns a document. Documents |
PATCH | /documents/{id} | Update a document Updates a document. Documents |
DELETE | /documents/{id} | Delete a document Deletes a document. Documents |
POST | /legalEntities | Create a legal entity Creates a legal entity. This resource contains information about the user that will be |
GET | /legalEntities/{id} | Get a legal entity Returns a legal entity. Legal entities |
PATCH | /legalEntities/{id} | Update a legal entity Updates a legal entity. >To change the legal entity type, include only the new `type` |
GET | /legalEntities/{id}/businessLines | Get all business lines under a legal entity Returns the business lines owned by a legal entity. Legal entities |
POST | /legalEntities/{id}/checkVerificationErrors | Check a legal entity's verification errors Returns the verification errors for a legal entity and its supporti |
POST | /legalEntities/{id}/onboardingLinks | Get a link to an Adyen-hosted onboarding page Returns a link to an Adyen-hosted onboarding page where you need |
GET | /legalEntities/{id}/pciQuestionnaires | Get PCI questionnaire details Get a list of signed PCI questionnaires. PCI questionnaires |
POST | /legalEntities/{id}/pciQuestionnaires/generatePciTemplates | Generate PCI questionnaire Generates the required PCI questionnaire based on the user's [salesChannel](https:/ |
POST | /legalEntities/{id}/pciQuestionnaires/signPciTemplates | Sign PCI questionnaire Signs the required PCI questionnaire. PCI questionnaires |
GET | /legalEntities/{id}/pciQuestionnaires/{pciid} | Get PCI questionnaire Returns the signed PCI questionnaire. PCI questionnaires |
POST | /legalEntities/{id}/termsOfService | Get Terms of Service document Returns the Terms of Service document for a legal entity. Terms of Service |
PATCH | /legalEntities/{id}/termsOfService/{termsofservicedocumentid} | Accept Terms of Service Accepts Terms of Service. Terms of Service |
GET | /legalEntities/{id}/termsOfServiceAcceptanceInfos | Get Terms of Service information for a legal entity Returns Terms of Service information for a legal entity. T |
GET | /themes | Get a list of hosted onboarding page themes Returns a list of hosted onboarding page themes. Hosted Onboarding |
GET | /themes/{id} | Get an onboarding link theme Returns the details of the theme identified in the path. Hosted Onboarding |
POST | /transferInstruments | Create a transfer instrument Creates a transfer instrument. A transfer instrument is a bank account that a l |
GET | /transferInstruments/{id} | Get a transfer instrument Returns the details of a transfer instrument. Transfer instruments |
PATCH | /transferInstruments/{id} | Update a transfer instrument Updates a transfer instrument. Transfer instruments |
DELETE | /transferInstruments/{id} | Delete a transfer instrument Deletes a transfer instrument. Transfer instruments |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/LegalEntityService-v3.json
Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort). This API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payme
| method | path | what the vendor says it does |
|---|---|---|
POST | /applePay/sessions | Get an Apple Pay session You need to use this endpoint if you have an API-only integration with Apple Pay whic |
POST | /cancels | Cancel an authorised payment Cancels the authorisation on a payment that has not yet been [captured](https://d |
POST | /cardDetails | Get the list of brands on the card Send a request with at least the first 6 digits of the card number to get a |
POST | /donations | Start a transaction for donations Takes in the donation token generated by the `/payments` request and uses it |
POST | /orders | Create an order Creates an order to be used for partial payments. Make a POST `/orders` call before making a ` |
POST | /orders/cancel | Cancel an order Cancels an order. Cancellation of an order results in an automatic rollback of all payments ma |
POST | /originKeys | Create originKey values for domains This operation takes the origin domains and returns a JSON object containi |
POST | /paymentLinks | Create a payment link Creates a payment link to our hosted payment form where shoppers can pay. The list of pa |
GET | /paymentLinks/{linkId} | Get a payment link Retrieves the payment link details using the payment link `id`. Payment links |
PATCH | /paymentLinks/{linkId} | Update the status of a payment link Updates the status of a payment link. Use this endpoint to [force the expi |
POST | /paymentMethods | Get a list of available payment methods Queries the available payment methods for a transaction based on the t |
POST | /paymentMethods/balance | Get the balance of a gift card Retrieves the balance remaining on a shopper's gift card. To check a gift card' |
POST | /paymentSession | Create a payment session Provides the data object that can be used to start the Checkout SDK. To set up the pa |
POST | /payments | Start a transaction Sends payment parameters (like amount, country, and currency) together with other required |
POST | /payments/details | Submit details for a payment Submits details for a payment created using `/payments`. This step is only needed |
POST | /payments/result | Verify a payment result Verifies the payment result using the payload returned from the Checkout SDK. For mor |
POST | /payments/{paymentPspReference}/amountUpdates | Update an authorised amount Increases or decreases the authorised payment amount and returns a unique referenc |
POST | /payments/{paymentPspReference}/cancels | Cancel an authorised payment Cancels the authorisation on a payment that has not yet been [captured](https://d |
POST | /payments/{paymentPspReference}/captures | Capture an authorised payment Captures an authorised payment and returns a unique reference for this request. |
POST | /payments/{paymentPspReference}/refunds | Refund a captured payment Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/Che |
POST | /payments/{paymentPspReference}/reversals | Refund or cancel a payment [Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payment |
POST | /sessions | Create a payment session Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/we |
GET | /storedPaymentMethods | Get tokens for stored payment details Lists the tokens for stored payment details for the shopper identified i |
DELETE | /storedPaymentMethods/{recurringId} | Delete a token for stored payment details Deletes the token identified in the path. The token can no longer be |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/CheckoutService-v70.json
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead. The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documen
| method | path | what the vendor says it does |
|---|---|---|
POST | /checkAccountHolder | Trigger verification Triggers the verification of an account holder even if the checks are not yet required fo |
POST | /closeAccount | Close an account Closes an account. If an account is closed, you cannot process transactions, pay out its fund |
POST | /closeAccountHolder | Close an account holder Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-plat |
POST | /closeStores | Close stores Closes stores associated with an account holder. Account holders |
POST | /createAccount | Create an account Creates an account under an account holder. An account holder can have [multiple accounts](h |
POST | /createAccountHolder | Create an account holder Creates an account holder that [represents the sub-merchant's entity](https://docs.ad |
POST | /deleteBankAccounts | Delete bank accounts Deletes bank accounts associated with an account holder. Verification |
POST | /deleteLegalArrangements | Delete legal arrangements Deletes legal arrangements and/or legal arrangement entities associated with an acco |
POST | /deletePayoutMethods | Delete payout methods Deletes payout methods associated with an account holder. Verification |
POST | /deleteShareholders | Delete shareholders Deletes shareholders associated with an account holder. Verification |
POST | /deleteSignatories | Delete signatories Deletes signatories associated with an account holder. Verification |
POST | /getAccountHolder | Get an account holder Returns the details of an account holder. Account holders |
POST | /getTaxForm | Get a tax form Generates a tax form for account holders operating in the US. For more information, refer to [P |
POST | /getUploadedDocuments | Get documents Returns documents that were previously uploaded for an account holder. Adyen uses the documents |
POST | /suspendAccountHolder | Suspend an account holder Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-pl |
POST | /unSuspendAccountHolder | Unsuspend an account holder Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and- |
POST | /updateAccount | Update an account Updates the description or payout schedule of an account. Accounts |
POST | /updateAccountHolder | Update an account holder Updates the `accountHolderDetails` and `processingTier` of an account holder, and add |
POST | /updateAccountHolderState | Update payout or processing state Disables or enables the processing or payout state of an account holder. Acc |
POST | /uploadDocument | Upload a document Uploads a document for an account holder. Adyen uses the documents during the [verification |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/AccountService-v6.json
A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential]
| method | path | what the vendor says it does |
|---|---|---|
POST | /adjustAuthorisation | Change the authorised amount Allows you to increase or decrease the authorised amount after the initial author |
POST | /authorise | Create an authorisation Creates a payment with a unique reference (`pspReference`) and attempts to obtain an a |
POST | /authorise3d | Complete a 3DS authorisation For an authenticated 3D Secure session, completes the payment authorisation. This |
POST | /authorise3ds2 | Complete a 3DS2 authorisation For an authenticated 3D Secure 2 session, completes the payment authorisation. T |
POST | /cancel | Cancel an authorisation Cancels the authorisation hold on a payment, returning a unique reference for this req |
POST | /cancelOrRefund | Cancel or refund a payment Cancels a payment if it has not been captured yet, or refunds it if it has already |
POST | /capture | Capture an authorisation Captures the authorisation hold on a payment, returning a unique reference for this r |
POST | /donate | Create a donation Schedules a new payment to be created (including a new authorisation request) for the specif |
POST | /getAuthenticationResult | Get the 3DS authentication result Return the authentication result after doing a 3D Secure authentication only |
POST | /refund | Refund a captured payment Refunds a payment that has previously been captured, returning a unique reference fo |
POST | /retrieve3ds2Result | Get the 3DS2 authentication result Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication onl |
POST | /technicalCancel | Cancel an authorisation using your reference This endpoint allows you to cancel a payment if you do not have t |
POST | /voidPendingRefund | Cancel an in-person refund This endpoint allows you to cancel an unreferenced refund request before it has bee |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/PaymentService-v68.json
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead. The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds
| method | path | what the vendor says it does |
|---|---|---|
POST | /accountHolderBalance | Get the balances of an account holder Returns the account balances of an account holder. An account's balances |
POST | /accountHolderTransactionList | Get a list of transactions Returns a list of transactions for an account holder's accounts. You can specify th |
POST | /debitAccountHolder | Send a direct debit request Sends a direct debit request to an account holder's bank account. If the direct de |
POST | /payoutAccountHolder | Pay out from an account to the account holder Pays out a specified amount from an account to the bank account |
POST | /refundFundsTransfer | Refund a funds transfer Refunds funds transferred from one account to another. Both accounts must be in the sa |
POST | /refundNotPaidOutTransfers | Refund all transactions of an account since the most recent payout Refunds all the transactions of an account |
POST | /setupBeneficiary | Designate a beneficiary account and transfer the benefactor's current balance Defines a benefactor and a benef |
POST | /transferFunds | Transfer funds between platform accounts Transfers funds from one account to another account. Both accounts mu |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/FundService-v6.json
A set of API endpoints that allow you to store payout details, confirm, or decline a payout. For more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts). ## Authentication To use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout detail
| method | path | what the vendor says it does |
|---|---|---|
POST | /confirmThirdParty | Confirm a payout Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` end |
POST | /declineThirdParty | Cancel a payout Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdPa |
POST | /payout | Make an instant card payout With this call, you can pay out to your customers, and funds will be made availabl |
POST | /storeDetail | Store payout details Stores payment details under the `PAYOUT` recurring contract. These payment details can b |
POST | /storeDetailAndSubmitThirdParty | Store details and submit a payout Submits a payout and stores its details for subsequent payouts. The submitt |
POST | /submitThirdParty | Submit a payout Submits a payout using the previously stored payment details. To store payment details, use th |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/PayoutService-v68.json
The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate t
| method | path | what the vendor says it does |
|---|---|---|
POST | /createPermit | Create new permits linked to a recurring contract. Create permits for a recurring contract, including support |
POST | /disable | Disable stored payment details Disables stored payment details to stop charging a shopper with this particular |
POST | /disablePermit | Disable an existing permit. Disable a permit that was previously linked to a recurringDetailReference. General |
POST | /listRecurringDetails | Get stored payment details Lists the stored payment details for a shopper, if there are any available. The rec |
POST | /notifyShopper | Ask issuer to notify the shopper Sends a request to the issuer so they can inform the shopper about the upcomi |
POST | /scheduleAccountUpdater | Schedule running the Account Updater When making the API call, you can submit either the credit card informati |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/RecurringService-v68.json
A set of API endpoints to manage stored value products.
| method | path | what the vendor says it does |
|---|---|---|
POST | /changeStatus | Changes the status of the payment method. Changes the status of the provided payment method to the specified s |
POST | /checkBalance | Checks the balance. Checks the balance of the provided payment method. General |
POST | /issue | Issues a new card. Issues a new card of the given payment method. General |
POST | /load | Loads the payment method. Loads the payment method with the specified funds. General |
POST | /mergeBalance | Merge the balance of two cards. Increases the balance of the paymentmethod by the full amount left on the sour |
POST | /voidTransaction | Voids a transaction. Voids the referenced stored value transaction. General |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/StoredValueService-v46.jso
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead. The Notification Configuration API provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed.
| method | path | what the vendor says it does |
|---|---|---|
POST | /createNotificationConfiguration | Subscribe to notifications Creates a subscription to notifications informing you of events on your platform. A |
POST | /deleteNotificationConfigurations | Delete a notification subscription configuration Deletes an existing notification subscription configuration. |
POST | /getNotificationConfiguration | Get a notification subscription configuration Returns the details of the configuration of a notification subsc |
POST | /getNotificationConfigurationList | Get a list of notification subscription configurations Returns the details of the configurations of all of the |
POST | /testNotificationConfiguration | Test a notification configuration Tests an existing notification subscription configuration. For each event ty |
POST | /updateNotificationConfiguration | Update a notification subscription configuration Updates an existing notification subscription configuration. |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/NotificationConfigurationS
This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). #
| method | path | what the vendor says it does |
|---|---|---|
POST | /assignTerminals | Assign terminals Assigns one or more payment terminals to a merchant account or a store. You can also use this |
POST | /findTerminal | Get the account or store of a terminal Returns the company account, merchant account, or store that a payment |
POST | /getStoresUnderAccount | Get the stores of an account Returns a list of stores associated with a company account or a merchant account, |
POST | /getTerminalDetails | Get the details of a terminal Returns the details of a payment terminal, including where the terminal is assig |
POST | /getTerminalsUnderAccount | Get the list of terminals Returns a list of payment terminals associated with a company account, merchant acco |
specification origin: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/TfmAPIService-v1.json
and 13 more specification(s) from adyen.com, all indexed.
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.