Skip to main content

Adyen

Process payments across various sales channels with Adyen.

Adyen Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 380 actions:

ActionPurposeParameters
account_service/post_check_account_holderTriggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing.data: {
. accountHolderCode (string)
. accountStateType (string)
. tier (integer)
} (object) required
account_service/post_close_accountCloses an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.data: {
. accountCode (string)
} (object) required
account_service/post_close_account_holderChanges the status of an account holderhttps://docs.adyen.com/classic-platforms/account-holders-and-accounts account-holder-statuses to Closed. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a Closed statushttps://docs.adyen.com/api-explorer/ /Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status, the payments are sent to your liable acdata: {
. accountHolderCode (string)
} (object) required
account_service/post_close_storesCloses stores associated with an account holder.data: {
. accountHolderCode (string)
. stores (array)
} (object) required
account_service/post_create_accountCreates an account under an account holder. An account holder can have multiple accountshttps://docs.adyen.com/classic-platforms/account-holders-and-accounts create-additional-accounts.data: {
. accountHolderCode (string)
. bankAccountUUID (string)
. description (string)
. metadata (object)
. payoutMethodCode (string)
. payoutSchedule (string)
. payoutScheduleReason (string)
. payoutSpeed (string)
} (object) required
account_service/post_create_account_holderCreates an account holder that represents the sub-merchant's entityhttps://docs.adyen.com/classic-platforms/account-structure your-platform in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to Account holder and accountshttps://docs.adyen.com/classic-platforms/account-holders-and-accounts legal-entity-types.data: {
. accountHolderCode (string)
. accountHolderDetails
. createDefaultAccount (boolean)
. description (string)
. legalEntity (string)
. primaryCurrency (string)
. processingTier (integer)
. verificationProfile (string)
} (object) required
account_service/post_delete_bank_accountsDeletes bank accounts associated with an account holder.data: {
. accountHolderCode (string)
. bankAccountUUIDs (array)
} (object) required
account_service/post_delete_legal_arrangementsDeletes legal arrangements and/or legal arrangement entities associated with an account holder.data: {
. accountHolderCode (string)
. legalArrangements (array)
} (object) required
account_service/post_delete_payout_methodsDeletes payout methods associated with an account holder.data: {
. accountHolderCode (string)
. payoutMethodCodes (array)
} (object) required
account_service/post_delete_shareholdersDeletes shareholders associated with an account holder.data: {
. accountHolderCode (string)
. shareholderCodes (array)
} (object) required
account_service/post_delete_signatoriesDeletes signatories associated with an account holder.data: {
. accountHolderCode (string)
. signatoryCodes (array)
} (object) required
account_service/post_get_account_holderReturns the details of an account holder.data: {
. accountCode (string)
. accountHolderCode (string)
. showDetails (boolean)
} (object) required
account_service/post_get_tax_formGenerates a tax form for account holders operating in the US. For more information, refer to Providing tax formshttps://docs.adyen.com/classic-platforms/tax-forms.data: {
. accountHolderCode (string)
. formType (string)
. year (integer)
} (object) required
account_service/post_get_uploaded_documentsReturns documents that were previously uploaded for an account holder. Adyen uses the documents during the verification processhttps://docs.adyen.com/classic-platforms/verification-process.data: {
. accountHolderCode (string)
. bankAccountUUID (string)
. shareholderCode (string)
} (object) required
account_service/post_suspend_account_holderChanges the status of an account holderhttps://docs.adyen.com/classic-platforms/account-holders-and-accounts account-holder-statuses to Suspended.data: {
. accountHolderCode (string)
} (object) required
account_service/post_un_suspend_account_holderChanges the status of an account holderhttps://docs.adyen.com/classic-platforms/account-holders-and-accounts account-holder-statuses from Suspended to Inactive. Account holders can have a Suspended statushttps://docs.adyen.com/api-explorer/ /Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status if you suspend them through the /suspendAccountHolderhttps://docs.adyen.com/api-explorer/ /Account/v5/post/suspendAccountHolder endpoint or if a verification deadline exdata: {
. accountHolderCode (string)
} (object) required
account_service/post_update_accountUpdates the description or payout schedule of an account.data: {
. accountCode (string)
. bankAccountUUID (string)
. description (string)
. metadata (object)
. payoutMethodCode (string)
. payoutSchedule
. payoutSpeed (string)
} (object) required
account_service/post_update_account_holderUpdates the accountHolderDetails and processingTier of an account holder, and adds bank accounts and shareholders. When updating accountHolderDetails, parameters that are not included in the request are left unchanged except for the following object: metadata: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs. When updating any field in the following objects, you mustdata: {
. accountHolderCode (string)
. accountHolderDetails
. description (string)
. legalEntity (string)
. primaryCurrency (string)
. processingTier (integer)
. verificationProfile (string)
} (object) required
account_service/post_update_account_holder_stateDisables or enables the processing or payout state of an account holder.data: {
. accountHolderCode (string)
. disable (boolean)
. reason (string)
. stateType (string)
} (object) required
account_service/post_upload_documentUploads a document for an account holder. Adyen uses the documents during the verification processhttps://docs.adyen.com/classic-platforms/verification-process.data: {
. documentContent (string)
. documentDetail
} (object) required
balance_control_service/post_balance_transferStarts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: The source and destination merchant accounts must be under the same company account and legal entity. The source merchant account must have sufficient funds. The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, sendata: {
. amount
. description (string)
. fromMerchant (string)
. reference (string)
. toMerchant (string)
. type (string)
} (object) required
balance_platform_service/post_account_holdersCreates an account holder linked to a legal entityhttps://docs.adyen.com/api-explorer/ /legalentity/latest/post/legalEntities.data: {
. balancePlatform (string)
. capabilities (object)
. contactDetails
. description (string)
. legalEntityId (string)
. metadata (object)
. migratedAccountHolderCode (string)
. reference (string)
. timeZone (string)
} (object) required
balance_platform_service/get_account_holders_by_idReturns an account holder.id (string)
balance_platform_service/patch_account_holders_by_idUpdates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.id (string)
data: {
. balancePlatform (string)
. capabilities (object)
. contactDetails
. description (string)
. metadata (object)
. migratedAccountHolderCode (string)
. primaryBalanceAccount (string)
. reference (string)
. status (string)
. timeZone (string)
. verificationDeadlines (array)
} (object) required
balance_platform_service/get_account_holders_by_id_balance_accountsReturns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use /accountHolders/id/balanceAccounts?limit=5 and offset=10.id (string)
offset (integer)
limit (integer)
balance_platform_service/get_account_holders_by_id_tax_formsGenerates a tax form for account holders operating in the US. For more information, refer to US tax forms for marketplaceshttps://docs.adyen.com/marketplaces/us-tax-forms/ or platformshttps://docs.adyen.com/platforms/us-tax-forms/ .id (string)
formType (string) required
year (integer) required
legalEntityId (string)
balance_platform_service/get_account_holders_by_id_transaction_rulesReturns a list of transaction rules associated with an account holder.id (string)
balance_platform_service/post_balance_accountsCreates a balance account that holds the funds of the associated account holder.data: {
. accountHolderId (string)
. defaultCurrencyCode (string)
. description (string)
. metadata (object)
. migratedAccountCode (string)
. platformPaymentConfiguration
. reference (string)
. timeZone (string)
} (object) required
balance_platform_service/get_balance_accounts_by_balance_account_id_sweepsReturns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use /balanceAccounts/balanceAccountId/sweeps?limit=5 and offset=10.balanceAccountId (string)
offset (integer)
limit (integer)
balance_platform_service/post_balance_accounts_by_balance_account_id_sweepsCreates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.balanceAccountId (string)
data: {
. category (string)
. counterparty
. currency (string)
. description (string)
. priorities (array)
. reason (string)
. reasonDetail (string)
. reference (string)
. referenceForBeneficiary (string)
. schedule
. status (string)
. sweepAmount
. targetAmount
. triggerAmount
. type (string)
} (object) required
balance_platform_service/get_balance_accounts_by_balance_account_id_sweeps_by_sweep_idReturns a sweep.balanceAccountId (string)
sweepId (string)
balance_platform_service/delete_balance_accounts_by_balance_account_id_sweeps_by_sweep_idDeletes a sweep for a balance account.balanceAccountId (string)
sweepId (string)
balance_platform_service/patch_balance_accounts_by_balance_account_id_sweeps_by_sweep_idUpdates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.balanceAccountId (string)
sweepId (string)
data: {
. category (string)
. counterparty
. currency (string)
. description (string)
. id (string)
. priorities (array)
. reason (string)
. reasonDetail (string)
. reference (string)
. referenceForBeneficiary (string)
. schedule
. status (string)
. sweepAmount
. targetAmount
. triggerAmount
. type (string)
} (object) required
balance_platform_service/get_balance_accounts_by_idReturns a balance account and its balances for the default currency and other currencies with a non-zero balance.id (string)
balance_platform_service/patch_balance_accounts_by_idUpdates a balance account.id (string)
data: {
. accountHolderId (string)
. description (string)
. metadata (object)
. platformPaymentConfiguration
. reference (string)
. status (string)
. timeZone (string)
} (object) required
balance_platform_service/get_balance_accounts_by_id_payment_instrumentsReturns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments which are in active status and to skip the first 6, use /balanceAccounts/id/paymentInstruments?limit=3 and offset=6 and status=active.id (string)
offset (integer)
limit (integer)
status (string)
balance_platform_service/get_balance_accounts_by_id_transaction_rulesReturns a list of transaction rules associated with a balance account.id (string)
balance_platform_service/get_balance_platforms_by_idReturns a balance platform.id (string)
balance_platform_service/get_balance_platforms_by_id_account_holdersReturns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use /balancePlatforms/id/accountHolders?limit=5 and offset=20.id (string)
offset (integer)
limit (integer)
balance_platform_service/get_balance_platforms_by_id_transaction_rulesReturns a list of transaction rules associated with a balance platform.id (string)
balance_platform_service/get_cardordersReturns a paginated list of card orders.id (string)
cardManufacturingProfileId (string)
status (string)
txVariantCode (string)
createdSince (string)
createdUntil (string)
lockedSince (string)
lockedUntil (string)
serviceCenter (string)
offset (integer)
limit (integer)
balance_platform_service/get_cardorders_by_id_itemsReturns the item list of a specific card order.id (string)
offset (integer)
limit (integer)
balance_platform_service/get_grant_accounts_by_idReturns the details of the grant accounthttps://docs.adyen.com/platforms/capital grant-account.id (string)
balance_platform_service/get_grant_offersReturns a list of all grant offershttps://docs.adyen.com/platforms/capital grant-offers available for accountHolderId specified as a query parameter.accountHolderId (string) required
balance_platform_service/get_grant_offers_by_grant_offer_idReturns the details of a single grant offer.grantOfferId (string)
balance_platform_service/get_network_tokens_by_network_token_idReturns the details of a network token.networkTokenId (string)
balance_platform_service/patch_network_tokens_by_network_token_idUpdates the status of the network token.networkTokenId (string)
data: {
. status (string)
} (object) required
balance_platform_service/post_payment_instrument_groupsCreates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.data: {
. balancePlatform (string)
. description (string)
. properties (object)
. reference (string)
. txVariant (string)
} (object) required
balance_platform_service/get_payment_instrument_groups_by_idReturns the details of a payment instrument group.id (string)
balance_platform_service/get_payment_instrument_groups_by_id_transaction_rulesReturns a list of all the transaction rules associated with a payment instrument group.id (string)
balance_platform_service/post_payment_instrumentsCreates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to Issue cardshttps://docs.adyen.com/issuing/create-cards or Issue business accountshttps://docs.adyen.com/platforms/business-accounts.data: {
. balanceAccountId (string)
. bankAccount
. card
. description (string)
. issuingCountryCode (string)
. paymentInstrumentGroupId (string)
. reference (string)
. status (string)
. statusComment (string)
. statusReason (string)
. type (string)
} (object) required
balance_platform_service/post_payment_instruments_revealReturns the encrypted data of a specified payment instrument. These data include: - The primary account number PAN - The card verification code CVC - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: Bank Issuing PAN Reveal Webservice roledata: {
. encryptedKey (string)
. paymentInstrumentId (string)
} (object) required
balance_platform_service/get_payment_instruments_by_idReturns the details of a payment instrument.id (string)
balance_platform_service/patch_payment_instruments_by_idUpdates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with inactive status, you can still update the balance account associated with the card.id (string)
data: {
. balanceAccountId (string)
. card
. status (string)
. statusComment (string)
. statusReason (string)
} (object) required
balance_platform_service/get_payment_instruments_by_id_network_token_activation_dataGet the network token activation data for a payment instrument.id (string)
balance_platform_service/post_payment_instruments_by_id_network_token_activation_dataCreate provisioning data for a network token. Use the provisioning data to add a user's payment instrument to their digital wallet.id (string)
data: {
. sdkOutput (string)
} (object) required
balance_platform_service/get_payment_instruments_by_id_network_tokensList the network tokens connected to a payment instrument.id (string)
balance_platform_service/get_payment_instruments_by_id_revealReturns the primary account number PAN of a payment instrument. To make this request, your API credential must have the following rolehttps://docs.adyen.com/issuing/manage-access/api-credentials-web-service api-permissions: Balance Platform BCL PCI roleid (string)
balance_platform_service/get_payment_instruments_by_id_transaction_rulesReturns a list of transaction rules associated with a payment instrument.id (string)
balance_platform_service/post_pins_changeChanges the personal identification number PIN of a specified card. To make this request, your API credential must have the following role: Bank Issuing PIN Change Webservice roledata: {
. encryptedKey (string)
. encryptedPinBlock (string)
. paymentInstrumentId (string)
. token (string)
} (object) required
balance_platform_service/post_pins_revealReturns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: Bank Issuing PIN Reveal Webservice roledata: {
. encryptedKey (string)
. paymentInstrumentId (string)
} (object) required
balance_platform_service/get_public_keyGet an RSAhttps://en.wikipedia.org/wiki/RSA_cryptosystem public key to encrypt or decrypt card data. You need the RSA public key to generate the encryptedKey required to: - Change a PINhttps://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change. - Reveal a PINhttps://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal. - Reveal a PANhttps://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal.purpose (string)
format (string)
balance_platform_service/get_registered_devicesGet a paginated list of the SCA devices you have currently registered for a specific payment instrument.paymentInstrumentId (string) required
pageNumber (integer)
pageSize (integer)
balance_platform_service/post_registered_devicesInitiates the registration of a user's device for Strong Customer Authentication SCA. You can register SCA devices for business accountshttps://docs.adyen.com/platforms/business-accounts/sca/register-devices or Adyen-issued cardshttps://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/register-devices. For a successful request, the device must be eligible for SCA.data: {
. name (string)
. paymentInstrumentId (string)
. strongCustomerAuthentication
} (object) required
balance_platform_service/post_registered_devices_by_device_id_associationsInitiates an association between a user's registered SCA device and an Adyen resource. For example, you can associate an SCA device with additional business accountshttps://docs.adyen.com/platforms/business-accounts/sca/register-devices or Adyen-issued cardshttps://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/register-devices.deviceId (string)
data: {
. ids (array)
. type (string)
} (object) required
balance_platform_service/patch_registered_devices_by_device_id_associationsCompletes an association between a user's registered SCA device and an Adyen resource. For example, you can associate an SCA device with additional business accountshttps://docs.adyen.com/platforms/business-accounts/sca/register-devices or Adyen-issued cardshttps://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/register-devices. To complete the association, this endpoint validates the authentication data of the registered device.deviceId (string)
data: {
. ids (array)
. strongCustomerAuthentication
. type (string)
} (object) required
balance_platform_service/delete_registered_devices_by_idDeletes an SCA device from the list of registered devices of a specific payment instrument.id (string)
paymentInstrumentId (string) required
balance_platform_service/patch_registered_devices_by_idCompletes the registration of an SCA device by validating the authentication data of the device. You can register SCA devices for business accountshttps://docs.adyen.com/platforms/business-accounts/sca or Adyen-issued cardshttps://docs.adyen.com/issuing/3d-secure/oob-auth-sdk.id (string)
data: {
. name (string)
. paymentInstrumentId (string)
. strongCustomerAuthentication
} (object) required
balance_platform_service/post_transaction_rulesCreates a transaction rulehttps://docs.adyen.com/issuing/transaction-rules. When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see exampleshttps://docs.adyen.com/issuing/transaction-rules/examples.data: {
. aggregationLevel (string)
. description (string)
. endDate (string)
. entityKey
. interval
. outcomeType (string)
. reference (string)
. requestType (string)
. ruleRestrictions
. score (integer)
. startDate (string)
. status (string)
. type (string)
} (object) required
balance_platform_service/get_transaction_rules_by_transaction_rule_idReturns the details of a transaction rule.transactionRuleId (string)
balance_platform_service/delete_transaction_rules_by_transaction_rule_idDeletes a transaction rule.transactionRuleId (string)
balance_platform_service/patch_transaction_rules_by_transaction_rule_idUpdates a transaction rule. To update only the status of a transaction rule, send only the status parameter. All other parameters not provided in the request are left unchanged. When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.transactionRuleId (string)
data: {
. aggregationLevel (string)
. description (string)
. endDate (string)
. entityKey
. interval
. outcomeType (string)
. reference (string)
. requestType (string)
. ruleRestrictions
. score (integer)
. startDate (string)
. status (string)
. type (string)
} (object) required
balance_platform_service/post_transfer_routes_calculateReturns available transfer routes based on a combination of transfer country, currency, counterparty, and priorities. Use this endpoint to find optimal transfer priorities and associated requirements before you make a transferhttps://docs.adyen.com/api-explorer/transfers/latest/post/transfers.data: {
. balanceAccountId (string)
. balancePlatform (string)
. category (string)
. counterparty
. country (string)
. currency (string)
. priorities (array)
} (object) required
balance_platform_service/post_validate_bank_account_identificationValidates bank account identification details. You can use this endpoint to validate bank account details before you make a transferhttps://docs.adyen.com/api-explorer/transfers/latest/post/transfers or create a transfer instrumenthttps://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments.data: {
. accountIdentification
} (object) required
balance_platform_service/get_payment_instruments_by_payment_instrument_id_authorised_card_usersReturns the authorized users for a card.paymentInstrumentId (string)
balance_platform_service/post_payment_instruments_by_payment_instrument_id_authorised_card_usersAssigns authorized users to a card. Users must have the authorisedPaymentInstrumentUser capability to be able to use the card.paymentInstrumentId (string)
data: {
. legalEntityIds (array)
} (object) required
balance_platform_service/delete_payment_instruments_by_payment_instrument_id_authorised_card_usersDeletes the list of authorized users assigned to a card.paymentInstrumentId (string)
balance_platform_service/patch_payment_instruments_by_payment_instrument_id_authorised_card_usersUpdates the list of authorized users for a card. This request replaces all existing authorized users for the card.paymentInstrumentId (string)
data: {
. legalEntityIds (array)
} (object) required
balance_platform_service/get_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settingsReturns all balance webhook settings configured for triggering balance webhookshttps://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated.balancePlatformId (string)
webhookId (string)
balance_platform_service/post_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settingsConfigures the criteria for triggering balance webhookshttps://docs.adyen.com/api-explorer/balance-webhooks/1/post/balancePlatform.balanceAccount.balance.updated. Adyen sends balance webhooks to notify you of balance changes in your balance platform. They can be triggered when the balance reaches, exceeds, or drops below a specific value in a specific currency. You can get notified about balance changes in your entire balance platform, in the balance accounts of a specific user, or a specificbalancePlatformId (string)
webhookId (string)
data: {
. conditions (array)
. currency (string)
. status (string)
. target
. type (string)
} (object) required
balance_platform_service/get_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_idReturns the details of a specific balance webhook setting configured for triggering balance webhookshttps://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated.balancePlatformId (string)
webhookId (string)
settingId (string)
balance_platform_service/delete_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_idDeletes a balance webhook setting that contains the conditions for triggering balance webhookshttps://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated.balancePlatformId (string)
webhookId (string)
settingId (string)
balance_platform_service/patch_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_idUpdates the conditions the balance change needs to meet for Adyen to send a balance webhookhttps://docs.adyen.com/api-explorer/balance-webhooks/latest/post/balanceAccount.balance.updated.balancePlatformId (string)
webhookId (string)
settingId (string)
data: {
. conditions (array,null)
. currency (string)
. status (string)
. target
. type (string)
} (object) required
balance_platform_service/post_balance_accounts_by_id_transfer_limits_approveApprove transfer limits that are pending SCA authentication.id (string)
WWW-Authenticate (string)
data: {
. transferLimitIds (array)
} (object) required
balance_platform_service/get_balance_accounts_by_id_transfer_limitsFilter and view the transfer limits configured for a balance account using the balance account's unique id and the available query parameters.id (string)
scope (string)
transferType (string)
status (string)
balance_platform_service/post_balance_accounts_by_id_transfer_limitsCreate a transfer limit for your balance account using the unique id of your balance account.id (string)
WWW-Authenticate (string)
data: {
. amount
. endsAt (string)
. reference (string)
. scaInformation
. scope
. startsAt (string)
. transferType
} (object) required
balance_platform_service/get_balance_accounts_by_id_transfer_limits_currentGet all transfer limits that currently apply to a balance account using the unique id of the balance account.id (string)
scope (string)
transferType (string)
balance_platform_service/get_balance_accounts_by_id_transfer_limits_by_transfer_limit_idGet the details of a transfer limit using its unique transferLimitId.transferLimitId (string)
id (string)
balance_platform_service/delete_balance_accounts_by_id_transfer_limits_by_transfer_limit_idDelete a scheduled or pending transfer limit using its unique transferLimitId. You cannot delete an active limit.transferLimitId (string)
id (string)
balance_platform_service/get_balance_platforms_by_id_transfer_limitsFilter and view the transfer limits configured for your balance platform using the balance platform's unique id and the available query parameters.id (string)
scope (string)
transferType (string)
status (string)
balance_platform_service/post_balance_platforms_by_id_transfer_limitsCreate a transfer limit for your balance platform using the unique id of your balance platform.id (string)
data: {
. amount
. endsAt (string)
. reference (string)
. scaInformation
. scope
. startsAt (string)
. transferType
} (object) required
balance_platform_service/get_balance_platforms_by_id_transfer_limits_by_transfer_limit_idGet the details of a transfer limit using its unique transferLimitId.transferLimitId (string)
id (string)
balance_platform_service/delete_balance_platforms_by_id_transfer_limits_by_transfer_limit_idDelete a scheduled or pending transfer limit using its unique transferLimitId. You cannot delete an active limit.transferLimitId (string)
id (string)
bin_lookup_service/post_get3ds_availabilityVerifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to 3D Secure 2https://docs.adyen.com/online-payments/3d-secure/native-3ds2.data: {
. additionalData (object)
. brands (array)
. cardNumber (string)
. merchantAccount (string)
. recurringDetailReference (string)
. shopperReference (string)
} (object) required
bin_lookup_service/post_get_cost_estimateThis API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the /getCostEstimate endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this trdata: {
. amount
. assumptions
. cardNumber (string)
. encryptedCardNumber (string)
. merchantAccount (string)
. merchantDetails
. recurring
. selectedRecurringDetailReference (string)
. shopperInteraction (string)
. shopperReference (string)
} (object) required
capital_service/get_grantsReturns a list of all the grants of a specific account holder.counterpartyAccountHolderId (string) required
capital_service/post_grantsMake a request for a grant on behalf of an account holder.data: {
. amount
. counterparty
. grantAccountId (string)
. grantOfferId (string)
} (object) required
capital_service/get_grants_by_grant_idReturns the details of the specified grant.grantId (string)
capital_service/get_grants_by_grant_id_disbursements_by_disbursement_idReturns the details of a disbursement specified in the path.grantId (string)
disbursementId (string)
capital_service/patch_grants_by_grant_id_disbursements_by_disbursement_idUpdate the percentage of your user's net income that is deducted for repaying the grant.grantId (string)
disbursementId (string)
data: {
. repayment
} (object) required
capital_service/get_grants_by_grant_id_disbursementsReturns the disbursements of a specified grant.grantId (string)
capital_service/get_grant_accounts_by_idReturns the details of the specified grant account. This account tracks existing grants in your marketplace or platform.id (string)
capital_service/get_grant_offers_by_idReturns the details of the specified grant offer.id (string)
capital_service/get_grant_offersReturns a list of all grant offershttps://docs.adyen.com/platforms/capital grant-offers available for accountHolderId specified as a query parameter.accountHolderId (string)
checkout_service/post_apple_pay_sessionsYou need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the Apple Pay session validationhttps://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1 complete-apple-pay-session-validation.Idempotency-Key (string)
data: {
. displayName (string)
. domainName (string)
. merchantIdentifier (string)
} (object) required
checkout_service/post_cancelsCancels the authorisation on a payment that has not yet been capturedhttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/captures, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a TECHNICAL_CANCEL webhookhttps://docs.adyen.com/online-payments/cancel cancellation-webhook. If you want to cancel a payment using the pspReferencehttps://docs.adyen.com/api-explorer/Checkout/latest/post/payments responseIdempotency-Key (string)
data: {
. applicationInfo
. enhancedSchemeData
. merchantAccount (string)
. paymentReference (string)
. reference (string)
} (object) required
checkout_service/post_card_detailsUse this endpoint to get information about the card or network token that enables you to decide on the routing of the transaction and the eligibility of the card for the type of transaction. If you include your supported brandshttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/cardDetails__reqParam_supportedBrands in the request, the response also tells you if you support each brand that was identified on the cardhttps://docs.adyen.com/api-explorer/Checkout/latest/post/cardDetailIdempotency-Key (string)
data: {
. cardNumber (string)
. countryCode (string)
. encryptedCardNumber (string)
. merchantAccount (string)
. supportedBrands (array)
} (object) required
checkout_service/post_donation_campaignsQueries the available donation campaigns for a donation based on the donation context like merchant account, currency, and locale. The response contains active donation campaigns.Idempotency-Key (string)
data: {
. currency (string)
. locale (string)
. merchantAccount (string)
} (object) required
checkout_service/post_donationsTakes in the donation token generated by the /payments request and uses it to make the donation. For more information, see Donationshttps://docs.adyen.com/online-payments/donations.Idempotency-Key (string)
data: {
. accountInfo
. additionalData (object)
. amount
. applicationInfo
. authenticationData
. billingAddress
. browserInfo
. channel (string)
. checkoutAttemptId (string)
. conversionId (string)
. countryCode (string)
. dateOfBirth (string)
. deliverAt (string)
. deliveryAddress
. deviceFingerprint (string)
. donationAccount (string)
. donationCampaignId (string)
. donationOriginalPspReference (string)
. donationToken (string)
. lineItems (array)
. merchantAccount (string)
. merchantRiskIndicator
. metadata (object)
. mpiData
. origin (string)
. paymentMethod
. recurringProcessingModel (string)
. redirectFromIssuerMethod (string)
. redirectToIssuerMethod (string)
. reference (string)
. returnUrl (string)
. sessionValidity (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. socialSecurityNumber (string)
. telephoneNumber (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
} (object) required
checkout_service/post_ordersCreates an order to be used for partial payments. Make a POST /orders call before making a /payments call when processing payments with different payment methods.Idempotency-Key (string)
data: {
. amount
. expiresAt (string)
. merchantAccount (string)
. reference (string)
} (object) required
checkout_service/post_orders_cancelCancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.Idempotency-Key (string)
data: {
. merchantAccount (string)
. order
} (object) required
checkout_service/post_origin_keysThis operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. If you're still using origin key for your Web Drop-in or Components integration, we recommend switching to client keyhttps://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key. This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the numberIdempotency-Key (string)
data: {
. originDomains (array)
} (object) required
checkout_service/post_payment_linksCreates a payment link to a Pay by Linkhttps://docs.adyen.com/unified-commerce/pay-by-link/ page where the shopper can pay. The list of payment methods presented to the shopper depends on the currency and country parameters sent in the request. For more information, refer to Pay by Link documentationhttps://docs.adyen.com/online-payments/pay-by-link create-payment-links-through-api.Idempotency-Key (string)
data: {
. allowedPaymentMethods (array)
. amount
. applicationInfo
. billingAddress
. blockedPaymentMethods (array)
. captureDelayHours (integer)
. countryCode (string)
. dateOfBirth (string)
. deliverAt (string)
. deliveryAddress
. description (string)
. expiresAt (string)
. fundOrigin
. fundRecipient
. installmentOptions (object)
. lineItems (array)
. manualCapture (boolean)
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. metadata (object)
. platformChargebackLogic
. recurringProcessingModel (string)
. reference (string)
. requiredShopperFields (array)
. returnUrl (string)
. reusable (boolean)
. riskData
. shopperEmail (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. showRemovePaymentMethodButton (boolean)
. socialSecurityNumber (string)
. splitCardFundingSources (boolean)
. splits (array)
. store (string)
. storePaymentMethodMode (string)
. telephoneNumber (string)
. themeId (string)
. threeDS2RequestData
} (object) required
checkout_service/get_payment_links_by_link_idRetrieves the payment link details using the payment link id.linkId (string)
checkout_service/patch_payment_links_by_link_idUpdates the status of a payment link. Use this endpoint to force the expiry of a payment linkhttps://docs.adyen.com/online-payments/pay-by-link update-payment-link-status.linkId (string)
data: {
. status (string)
} (object) required
checkout_service/post_payment_methodsRetrieves the list of available payment methods for the transaction, based on the transaction information like amount, country, and currency.Idempotency-Key (string)
data: {
. additionalData (object)
. allowedPaymentMethods (array)
. amount
. blockedPaymentMethods (array)
. browserInfo
. channel (string)
. countryCode (string)
. merchantAccount (string)
. order
. shopperConversionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperLocale (string)
. shopperReference (string)
. splitCardFundingSources (boolean)
. store (string)
. storeFiltrationMode (string)
. telephoneNumber (string)
} (object) required
checkout_service/post_payment_methods_balanceRetrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST /paymentMethods/balance call and include the gift card's details inside a paymentMethod object.Idempotency-Key (string)
data: {
. accountInfo
. additionalAmount
. additionalData (object)
. amount
. applicationInfo
. billingAddress
. browserInfo
. captureDelayHours (integer)
. dateOfBirth (string)
. dccQuote
. deliveryAddress
. deliveryDate (string)
. deviceFingerprint (string)
. fraudOffset (integer)
. installments
. localizedShopperStatement (object)
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. merchantRiskIndicator
. metadata (object)
. orderReference (string)
. paymentMethod (object)
. recurring
. recurringProcessingModel (string)
. reference (string)
. selectedBrand (string)
. selectedRecurringDetailReference (string)
. sessionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. socialSecurityNumber (string)
. splits (array)
. store (string)
. telephoneNumber (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
. totalsGroup (string)
. trustedShopper (boolean)
} (object) required
checkout_service/post_paymentsSends payment parameters like amount, country, and currency together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our payment method guideshttps://docs.adyen.com/payment-methods. The response depends on the payment flowhttps://docs.adyen.com/payment-methods payment-flow: For a direct flow, the response includes a pspReference and a resultCode with the payment result, for example Authorised or RefusedIdempotency-Key (string)
data: {
. accountInfo
. additionalAmount
. additionalData (object)
. amount
. applicationInfo
. authenticationData
. bankAccount
. billingAddress
. browserInfo
. captureDelayHours (integer)
. channel (string)
. checkoutAttemptId (string)
. company
. conversionId (string)
. countryCode (string)
. dateOfBirth (string)
. dccQuote
. deliverAt (string)
. deliveryAddress
. deliveryDate (string)
. deviceFingerprint (string)
. enableOneClick (boolean)
. enablePayOut (boolean)
. enableRecurring (boolean)
. enhancedSchemeData
. entityType (string)
. fraudOffset (integer)
. fundOrigin
. fundRecipient
. industryUsage (string)
. installments
. lineItems (array)
. localizedShopperStatement (object)
. mandate
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. merchantRiskIndicator
. metadata (object)
. mpiData
. order
. orderReference (string)
. origin (string)
. paymentMethod
. platformChargebackLogic
. recurringExpiry (string)
. recurringFrequency (string)
. recurringProcessingModel (string)
. redirectFromIssuerMethod (string)
. redirectToIssuerMethod (string)
. reference (string)
. returnUrl (string)
. riskData
. sdkData (string)
. sessionValidity (string)
. shopperConversionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. socialSecurityNumber (string)
. splits (array)
. store (string)
. storePaymentMethod (boolean)
. subMerchants (array)
. surcharge
. telephoneNumber (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
. trustedShopper (boolean)
} (object) required
checkout_service/post_payments_detailsSubmits details for a payment created using /payments. This step is only needed when no final state has been reached on the /payments request, for example when the shopper was redirected to another page to complete the payment.Idempotency-Key (string)
data: {
. authenticationData
. details
. paymentData (string)
. threeDSAuthenticationOnly (boolean)
} (object) required
checkout_service/post_payments_by_payment_psp_reference_amount_updatesIncreases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an AUTHORISATION_ADJUSTMENT webhookhttps://docs.adyen.com/development-resources/webhooks/webhook-types/ event-codes. You can only update authorised amounts that have not yet been capturedhttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/captures. The amount you specify in the request is the updatpaymentPspReference (string)
Idempotency-Key (string)
data: {
. amount
. applicationInfo
. enhancedSchemeData
. industryUsage (string)
. lineItems (array)
. merchantAccount (string)
. reference (string)
. splits (array)
} (object) required
checkout_service/post_payments_by_payment_psp_reference_cancelsCancels the authorisation on a payment that has not yet been capturedhttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/captures, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCELLATION webhookhttps://docs.adyen.com/online-payments/cancel cancellation-webhook. If you want to cancel a payment but don't have the pspReferencehttps://docs.adyen.com/api-explorer/Checkout/latest/post/payments respaymentPspReference (string)
Idempotency-Key (string)
data: {
. applicationInfo
. enhancedSchemeData
. merchantAccount (string)
. reference (string)
} (object) required
checkout_service/post_payments_by_payment_psp_reference_capturesCaptures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CAPTURE webhookhttps://docs.adyen.com/online-payments/capture capture-notification. You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple ppaymentPspReference (string)
Idempotency-Key (string)
data: {
. amount
. applicationInfo
. enhancedSchemeData
. lineItems (array)
. merchantAccount (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. subMerchants (array)
} (object) required
checkout_service/post_payments_by_payment_psp_reference_refundsRefunds a payment that has been capturedhttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/captures, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a REFUND webhookhttps://docs.adyen.com/online-payments/refund refund-webhook. You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captupaymentPspReference (string)
Idempotency-Key (string)
data: {
. amount
. applicationInfo
. capturePspReference (string)
. enhancedSchemeData
. lineItems (array)
. merchantAccount (string)
. merchantRefundReason (string)
. reference (string)
. splits (array)
. store (string)
} (object) required
checkout_service/post_payments_by_payment_psp_reference_reversalsRefundshttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/refunds a payment if it has already been captured, and cancelshttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/payments/paymentPspReference/cancels a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCEL_OR_REFUND webhookhttps://docs.adyen.com/online-payments/reversal/ cancel-or-refundpaymentPspReference (string)
Idempotency-Key (string)
data: {
. applicationInfo
. enhancedSchemeData
. merchantAccount (string)
. reference (string)
} (object) required
checkout_service/post_paypal_update_orderUpdates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.Idempotency-Key (string)
data: {
. amount
. deliveryMethods (array)
. paymentData (string)
. pspReference (string)
. sessionId (string)
. taxTotal
} (object) required
checkout_service/post_sessionsCreates a payment session for Drop-inhttps://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web and integration=Drop-in, Componentshttps://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web and integration=Components, and Hosted Checkouthttps://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web and integration=Hosted+Checkout integrations. The response contains encrypted payment session data. The frontIdempotency-Key (string)
data: {
. accountInfo
. additionalAmount
. additionalData (object)
. allowedPaymentMethods (array)
. amount
. applicationInfo
. authenticationData
. billingAddress
. blockedPaymentMethods (array)
. captureDelayHours (integer)
. channel (string)
. company
. countryCode (string)
. dateOfBirth (string)
. deliverAt (string)
. deliveryAddress
. enableOneClick (boolean)
. enablePayOut (boolean)
. enableRecurring (boolean)
. expiresAt (string)
. fundOrigin
. fundRecipient
. installmentOptions (object)
. lineItems (array)
. mandate
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. metadata (object)
. mode (string)
. mpiData
. platformChargebackLogic
. recurringExpiry (string)
. recurringFrequency (string)
. recurringProcessingModel (string)
. redirectFromIssuerMethod (string)
. redirectToIssuerMethod (string)
. reference (string)
. returnUrl (string)
. riskData
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. showInstallmentAmount (boolean)
. showRemovePaymentMethodButton (boolean)
. socialSecurityNumber (string)
. splitCardFundingSources (boolean)
. splits (array)
. store (string)
. storeFiltrationMode (string)
. storePaymentMethod (boolean)
. storePaymentMethodMode (string)
. telephoneNumber (string)
. themeId (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
. trustedShopper (boolean)
} (object) required
checkout_service/get_sessions_by_session_idReturns the status of the payment session with the sessionId and sessionResult specified in the path.sessionId (string)
sessionResult (string) required
checkout_service/get_stored_payment_methodsLists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included.shopperReference (string)
merchantAccount (string)
checkout_service/post_stored_payment_methodsCreates a token to store the shopper's payment details. This token can be used for the shopper's future payments.Idempotency-Key (string)
data: {
. merchantAccount (string)
. paymentMethod
. recurringProcessingModel (string)
. shopperEmail (string)
. shopperIP (string)
. shopperReference (string)
} (object) required
checkout_service/delete_stored_payment_methods_by_stored_payment_method_idDeletes the token identified in the path. The token can no longer be used with payment requests.storedPaymentMethodId (string)
shopperReference (string) required
merchantAccount (string) required
checkout_service/post_validate_shopper_idValidates the shopperId.data: {
. merchantAccount (string)
. paymentMethod
. shopperEmail (string)
. shopperIP (string)
. shopperReference (string)
} (object) required
data_protection_service/post_request_subject_erasureSends the PSP reference containing the shopper data that should be deleted.data: {
. forceErasure (boolean)
. merchantAccount (string)
. pspReference (string)
} (object) required
dispute_service/post_accept_disputeAccepts a specific dispute.data: {
. disputePspReference (string)
. merchantAccountCode (string)
} (object) required
dispute_service/post_defend_disputeDefends a specific dispute.data: {
. defenseReasonCode (string)
. disputePspReference (string)
. merchantAccountCode (string)
} (object) required
dispute_service/post_delete_dispute_defense_documentDeletes a specific dispute defense document that was supplied earlier.data: {
. defenseDocumentType (string)
. disputePspReference (string)
. merchantAccountCode (string)
} (object) required
dispute_service/post_retrieve_applicable_defense_reasonsReturns a list of all applicable defense reasons to defend a specific dispute.data: {
. disputePspReference (string)
. merchantAccountCode (string)
} (object) required
dispute_service/post_supply_defense_documentSupplies a specific dispute defense document.data: {
. defenseDocuments (array)
. disputePspReference (string)
. merchantAccountCode (string)
} (object) required
fund_service/post_account_holder_balanceReturns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.data: {
. accountHolderCode (string)
} (object) required
fund_service/post_account_holder_transaction_listReturns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.data: {
. accountHolderCode (string)
. transactionListsPerAccount (array)
. transactionStatuses (array)
} (object) required
fund_service/post_debit_account_holderSends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the split instructions. Adyen sends the result of the direct debit in a DIRECT_DEBIT_INITIATEDhttps://docs.adyen.com/api-explorer/ /NotificationService/latest/post/DIRECT_DEBIT_INITIATED notification webhook. To learn more about direct debits, see Top up accountshttps://docs.adyen.com/classic-platforms/top-up-accounts.data: {
. accountHolderCode (string)
. amount
. bankAccountUUID (string)
. description (string)
. merchantAccount (string)
. splits (array)
} (object) required
fund_service/post_payout_account_holderPays out a specified amount from an account to the bank account of account holder.data: {
. accountCode (string)
. accountHolderCode (string)
. amount
. bankAccountUUID (string)
. description (string)
. merchantReference (string)
. payoutMethodCode (string)
. payoutSpeed (string)
} (object) required
fund_service/post_refund_funds_transferRefunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders.data: {
. amount
. merchantReference (string)
. originalReference (string)
} (object) required
fund_service/post_refund_not_paid_out_transfersRefunds all the transactions of an account that have taken place since the most recent payout. This request is on a account basis as opposed to a payment basis, so only the portion of the payment that was made to the specified account is refunded. The commissions, fees, and payments to other accounts remain in the accounts to which they were sent as designated by the original payment's split details.data: {
. accountCode (string)
. accountHolderCode (string)
} (object) required
fund_service/post_setup_beneficiaryDefines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.data: {
. destinationAccountCode (string)
. merchantReference (string)
. sourceAccountCode (string)
} (object) required
fund_service/post_transfer_fundsTransfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must include a transfer code, which should be determined by the platform, in compliance with local regulations.data: {
. amount
. destinationAccountCode (string)
. merchantReference (string)
. sourceAccountCode (string)
. transferCode (string)
} (object) required
foreign_exchange_service/post_rates_calculateReturns the calculated amounts and rates required to convert the currency of a transaction.data: {
. exchangeCalculations (array)
} (object) required
hop_service/post_get_onboarding_urlReturns a link to an Adyen-hosted onboarding page HOP that you can send to your account holder. For more information on how to use HOP, refer to Hosted onboardinghttps://docs.adyen.com/classic-platforms/onboard-users/hosted-onboarding-page.data: {
. accountHolderCode (string)
. collectInformation
. editMode (boolean)
. mobileOAuthCallbackUrl (string)
. platformName (string)
. returnUrl (string)
. shopperLocale (string)
. showPages
} (object) required
hop_service/post_get_pci_questionnaire_urlReturns a link to a PCI compliance questionnaire that you can send to your account holder. You should only use this endpoint if you have a partner platform setuphttps://docs.adyen.com/classic-platforms/platforms-for-partners.data: {
. accountHolderCode (string)
. returnUrl (string)
} (object) required
legal_entity_service/post_business_linesCreates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations.Adyen informs you of the verification results through webhooks or API responses. You can create a maximum of 200 business lines per legal entity for payment processing. Requests to this endpoint are subject to rate limits: - Live environments: 700 requesdata: {
. industryCode (string)
. legalEntityId (string)
. salesChannels (array)
. service (string)
. sourceOfFunds
. webData (array)
. webDataExemption
} (object) required
legal_entity_service/delete_business_lines_by_idDeletes a business line. If you delete a business line linked to a payment methodhttps://docs.adyen.com/development-resources/paymentmethodvariant management-api, it can affect your merchant account's ability to use the payment methodhttps://docs.adyen.com/api-explorer/Management/latest/post/merchants/merchantId/paymentMethodSettings. The business line is removed from all linked merchant accounts. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5id (string)
legal_entity_service/get_business_lines_by_idReturns the detail of a business line. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/patch_business_lines_by_idUpdates a business line. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. industryCode (string)
. salesChannels (array)
. sourceOfFunds
. webData (array)
. webDataExemption
} (object) required
legal_entity_service/post_documentsUploads a document for verification checks. Adyen uses the information from the legal entityhttps://docs.adyen.com/api-explorer/ /legalentity/latest/post/legalEntities to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. You can upload a maximum of 15 pages for photo IDs. Requests to this endpoint are subject to rate limits: - Livex-requested-verification-code (string)
data: {
. attachment
. attachments (array)
. creationDate (string)
. description (string)
. expiryDate (string)
. fileName (string)
. id (string)
. issuerCountry (string)
. issuerState (string)
. modificationDate (string)
. number (string)
. owner
. type (string)
} (object) required
legal_entity_service/delete_documents_by_idDeletes a document. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/get_documents_by_idReturns a document. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
skipContent (boolean)
legal_entity_service/patch_documents_by_idUpdates a document. You can upload a maximum of 15 pages for photo IDs. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
x-requested-verification-code (string)
data: {
. attachment
. attachments (array)
. creationDate (string)
. description (string)
. expiryDate (string)
. fileName (string)
. id (string)
. issuerCountry (string)
. issuerState (string)
. modificationDate (string)
. number (string)
. owner
. type (string)
} (object) required
legal_entity_service/post_legal_entitiesCreates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit ox-requested-verification-code (string)
data: {
. capabilities (object)
. entityAssociations (array)
. individual
. organization
. reference (string)
. soleProprietorship
. trust
. type (string)
. unincorporatedPartnership
. verificationPlan (string)
} (object) required
legal_entity_service/get_legal_entities_by_idReturns a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/patch_legal_entities_by_idUpdates a legal entity. To change the legal entity type, include only the new type in your request. If you need to update information for the legal entity, make a separate request. To update the entityAssociations array, you need to replace the entire array.For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds.id (string)
x-requested-verification-code (string)
data: {
. capabilities (object)
. entityAssociations (array)
. individual
. organization
. reference (string)
. soleProprietorship
. trust
. type (string)
. unincorporatedPartnership
. verificationPlan (string)
} (object) required
legal_entity_service/get_legal_entities_by_id_accepted_terms_of_service_document_by_termsofserviceacceptancereferenceReturns the accepted Terms of Service document for a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
termsofserviceacceptancereference (string)
termsOfServiceDocumentFormat (string)
legal_entity_service/get_legal_entities_by_id_business_linesReturns the business lines owned by a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_legal_entities_by_id_check_tax_electronic_delivery_consentReturns the consent status for electronic delivery of tax forms. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_legal_entities_by_id_check_verification_errorsReturns the verification errors for a legal entity and its supporting entities. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_legal_entities_by_id_confirm_data_reviewConfirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_legal_entities_by_id_onboarding_linksReturns a link to an Adyen-hosted onboarding page where you need to redirect your user. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. locale (string)
. redirectUrl (string)
. settings
. themeId (string)
} (object) required
legal_entity_service/get_legal_entities_by_id_pci_questionnairesGet a list of signed PCI questionnaires. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_generate_pci_templatesGenerates the required PCI questionnaires based on the user's salesChannelhttps://docs.adyen.com/api-explorer/ /legalentity/latest/post/businessLines__reqParam_salesChannels. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. additionalSalesChannels (array)
. language (string)
} (object) required
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_sign_pci_templatesSigns the required PCI questionnaire. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. pciTemplateReferences (array)
. signedBy (string)
} (object) required
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_signing_requiredCalculate PCI status of a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. additionalSalesChannels (array)
} (object) required
legal_entity_service/get_legal_entities_by_id_pci_questionnaires_by_pciidReturns the signed PCI questionnaire. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
pciid (string)
legal_entity_service/post_legal_entities_by_id_set_tax_electronic_delivery_consentSet the consent status for electronic delivery of tax forms. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. US1099k (boolean)
} (object) required
legal_entity_service/post_legal_entities_by_id_terms_of_serviceReturns the Terms of Service document for a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
data: {
. language (string)
. termsOfServiceDocumentFormat (string)
. type (string)
} (object) required
legal_entity_service/patch_legal_entities_by_id_terms_of_service_by_termsofservicedocumentidAccepts Terms of Service. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
termsofservicedocumentid (string)
data: {
. acceptedBy (string)
. ipAddress (string)
} (object) required
legal_entity_service/get_legal_entities_by_id_terms_of_service_acceptance_infosReturns Terms of Service information for a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/get_legal_entities_by_id_terms_of_service_statusReturns the required types of Terms of Service that need to be accepted by a legal entity. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/get_themesReturns a list of hosted onboarding page themes. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.No parameters
legal_entity_service/get_themes_by_idReturns the details of the theme identified in the path. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/post_transfer_instrumentsCreates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument such as payouts. Requests to this endpoint are subject to rate limits: -x-requested-verification-code (string)
data: {
. bankAccount
. legalEntityId (string)
. type (string)
} (object) required
legal_entity_service/delete_transfer_instruments_by_idDeletes a transfer instrument. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/get_transfer_instruments_by_idReturns the details of a transfer instrument. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
legal_entity_service/patch_transfer_instruments_by_idUpdates a transfer instrument. Requests to this endpoint are subject to rate limits: - Live environments: 700 requests per 5 seconds. - Test environments: 200 requests per 5 seconds. - Failed requests are subject to a limit of 5 failures per 10 seconds.id (string)
x-requested-verification-code (string)
data: {
. bankAccount
. legalEntityId (string)
. type (string)
} (object) required
management_service/get_companiesReturns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Account readpageNumber (integer)
pageSize (integer)
management_service/get_companies_by_company_idReturns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Account readcompanyId (string)
management_service/get_companies_by_company_id_android_appsReturns a list of the Android apps that are available for the company identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through terminal actionshttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Android filescompanyId (string)
pageNumber (integer)
pageSize (integer)
packageName (string)
versionCode (integer)
management_service/post_companies_by_company_id_android_appsUploads an Android APK file to Adyen. The maximum APK file size is 200 MB. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Android files read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment. By choosing to upload, install, or run any third-companyId (string)
management_service/get_companies_by_company_id_android_apps_by_idReturns the details of the Android app identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through terminal actionshttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Android files read Management API—Android ficompanyId (string)
id (string)
management_service/patch_companies_by_company_id_android_apps_by_idReuploads the Android app identified in the path. To make this request, your API credential must have this rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Android files read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment. By choosing to upload, install, or run any third-party applications on an Adyen pacompanyId (string)
id (string)
management_service/get_companies_by_company_id_android_certificatesReturns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certificates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through terminal actionshttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api. To make this request, your API credential must have one of the following roleshttps://doccompanyId (string)
pageNumber (integer)
pageSize (integer)
certificateName (string)
management_service/post_companies_by_company_id_android_certificatesUploads an Android Certificate file to Adyen. In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.companyId (string)
management_service/get_companies_by_company_id_api_credentialsReturns the list of API credentialshttps://docs.adyen.com/development-resources/api-credentials for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
pageNumber (integer)
pageSize (integer)
management_service/post_companies_by_company_id_api_credentialsCreates an API credentialhttps://docs.adyen.com/development-resources/api-credentials for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: API keyhttps://docs.adyen.com/development-resources/api-authentication api-key-authentication: used for API request authentication. Client keyhttps://docs.adycompanyId (string)
data: {
. allowedOrigins (array)
. associatedMerchantAccounts (array)
. description (string)
. roles (array)
} (object) required
management_service/get_companies_by_company_id_api_credentials_by_api_credential_idReturns the API credentialhttps://docs.adyen.com/development-resources/api-credentials identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
management_service/patch_companies_by_company_id_api_credentials_by_api_credential_idChanges the API credential's roles, merchant account access, 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
data: {
. active (boolean)
. allowedOrigins (array)
. associatedMerchantAccounts (array)
. description (string)
. roles (array)
} (object) required
management_service/get_companies_by_company_id_api_credentials_by_api_credential_id_allowed_originsReturns the list of allowed originshttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins for the API credential identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_allowed_originsAdds a new allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins to the API credential's list of allowed origins. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
data: {
. _links
. domain (string)
. id (string)
} (object) required
management_service/delete_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_idRemoves the allowed originhttps://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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
originId (string)
management_service/get_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_idReturns the allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
originId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_generate_api_keyReturns 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_generate_client_keyReturns a new client keyhttps://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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writecompanyId (string)
apiCredentialId (string)
management_service/get_companies_by_company_id_billing_entitiesReturns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write IcompanyId (string)
name (string)
management_service/get_companies_by_company_id_merchantsReturns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Account readcompanyId (string)
pageNumber (integer)
pageSize (integer)
management_service/get_companies_by_company_id_shipping_locationsReturns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read ancompanyId (string)
name (string)
offset (integer)
limit (integer)
management_service/post_companies_by_company_id_shipping_locationsCreates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-thecompanyId (string)
data: {
. address
. contact
. id (string)
. name (string)
} (object) required
management_service/get_companies_by_company_id_terminal_actionsReturns the terminal actionshttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal actions read Management API—Terminal actions read and write In the livcompanyId (string)
pageNumber (integer)
pageSize (integer)
status (string)
type (string)
management_service/get_companies_by_company_id_terminal_actions_by_action_idReturns the details of the terminal actionhttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal actions read Management API—Terminal actions read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/pocompanyId (string)
actionId (string)
management_service/get_companies_by_company_id_terminal_logosReturns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level merchant account, store, or individual terminal. To make this request, your API credential must have one of the following roleshttps://companyId (string)
model (string) required
management_service/patch_companies_by_company_id_terminal_logosUpdates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level merchant account, store, or individual terminal. To change the logo, specify the image file as a Base64-encoded string. To restore the logo inherited from the Adyen PSP level, specify an emcompanyId (string)
model (string) required
data: {
. data (string)
} (object) required
management_service/get_companies_by_company_id_terminal_modelsReturns a list of payment terminal models that the company 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. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In tcompanyId (string)
management_service/get_companies_by_company_id_terminal_ordersReturns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-companyId (string)
customerOrderReference (string)
status (string)
offset (integer)
limit (integer)
management_service/post_companies_by_company_id_terminal_ordersCreates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write 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 orderhttps://docs.adyen.com/point-of-sale/managing-terminals/order-tercompanyId (string)
data: {
. billingEntityId (string)
. customerOrderReference (string)
. items (array)
. orderType (string)
. shippingLocationId (string)
. taxId (string)
} (object) required
management_service/get_companies_by_company_id_terminal_orders_by_order_idReturns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environmencompanyId (string)
orderId (string)
management_service/patch_companies_by_company_id_terminal_orders_by_order_idUpdates the terminal products order identified in the path. Updating is only possible while the order has the status Placed. The request body only needs to contain what you want to change. However, to update the products in the items array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must havcompanyId (string)
orderId (string)
data: {
. billingEntityId (string)
. customerOrderReference (string)
. items (array)
. orderType (string)
. shippingLocationId (string)
. taxId (string)
} (object) required
management_service/post_companies_by_company_id_terminal_orders_by_order_id_cancelCancels the terminal products order identified in the path. Cancelling is only possible while the order has the status Placed. To 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. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write In the live environment, rcompanyId (string)
orderId (string)
management_service/get_companies_by_company_id_terminal_productsReturns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-tecompanyId (string)
country (string) required
terminalModelId (string)
offset (integer)
limit (integer)
management_service/get_companies_by_company_id_terminal_settingsReturns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level merchant account, store, or individual terminal. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and wcompanyId (string)
management_service/patch_companies_by_company_id_terminal_settingsUpdates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level merchant account, store, or individual terminal. 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. To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parametercompanyId (string)
data: {
. cardholderReceipt
. connectivity
. gratuities (array)
. hardware
. localization
. nexo
. offlineProcessing
. opi
. passcodes
. payAtTable
. payment
. receiptOptions
. receiptPrinting
. refunds
. signature
. standalone
. storeAndForward
. surcharge
. tapToPay
. terminalInstructions
. timeouts
. wifiProfiles
} (object) required
management_service/get_companies_by_company_id_usersReturns the list of users for the companyId identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writecompanyId (string)
pageNumber (integer)
pageSize (integer)
username (string)
management_service/post_companies_by_company_id_usersCreates the user for the companyId identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writecompanyId (string)
data: {
. accountGroups (array)
. associatedMerchantAccounts (array)
. email (string)
. loginMethod (string)
. name
. roles (array)
. timeZoneCode (string)
. username (string)
} (object) required
management_service/get_companies_by_company_id_users_by_user_idReturns user details for the userId and the companyId identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writecompanyId (string)
userId (string)
management_service/patch_companies_by_company_id_users_by_user_idUpdates user details for the userId and the companyId identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writecompanyId (string)
userId (string)
data: {
. accountGroups (array)
. active (boolean)
. associatedMerchantAccounts (array)
. email (string)
. loginMethod (string)
. name
. roles (array)
. timeZoneCode (string)
} (object) required
management_service/get_companies_by_company_id_webhooksLists all webhook configurations for the company account. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read Management API—Webhooks read and writecompanyId (string)
pageNumber (integer)
pageSize (integer)
management_service/post_companies_by_company_id_webhooksSubscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writecompanyId (string)
data: {
. acceptsExpiredCertificate (boolean)
. acceptsSelfSignedCertificate (boolean)
. acceptsUntrustedRootCertificate (boolean)
. active (boolean)
. additionalSettings
. communicationFormat (string)
. description (string)
. encryptionProtocol (string)
. filterMerchantAccountType (string)
. filterMerchantAccounts (array)
. networkType (string)
. password (string)
. populateSoapActionHeader (boolean)
. type (string)
. url (string)
. username (string)
} (object) required
management_service/delete_companies_by_company_id_webhooks_by_webhook_idRemove the configuration for the webhook identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writecompanyId (string)
webhookId (string)
management_service/get_companies_by_company_id_webhooks_by_webhook_idReturns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read Management API—Webhooks read and writecompanyId (string)
webhookId (string)
management_service/patch_companies_by_company_id_webhooks_by_webhook_idMake 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writecompanyId (string)
webhookId (string)
data: {
. acceptsExpiredCertificate (boolean)
. acceptsSelfSignedCertificate (boolean)
. acceptsUntrustedRootCertificate (boolean)
. active (boolean)
. additionalSettings
. communicationFormat (string)
. description (string)
. encryptionProtocol (string)
. filterMerchantAccountType (string)
. filterMerchantAccounts (array)
. networkType (string)
. password (string)
. populateSoapActionHeader (boolean)
. url (string)
. username (string)
} (object) required
management_service/post_companies_by_company_id_webhooks_by_webhook_id_generate_hmacReturns an HMAC keyhttps://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 notificationshttps://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures enable-hmac-signatures from Adyen. Find out more about how to verify HMAC signatureshttps://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures. To macompanyId (string)
webhookId (string)
management_service/post_companies_by_company_id_webhooks_by_webhook_id_testSends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the merchantIds array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP,companyId (string)
webhookId (string)
data: {
. merchantIds (array)
. notification
. types (array)
} (object) required
management_service/get_meReturns your API credentialhttps://docs.adyen.com/development-resources/api-credentials details based on the API Key you used in the request. You can make this request with any of the Management API roles.No parameters
management_service/get_me_allowed_originsReturns the list of allowed originshttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins of your API credentialhttps://docs.adyen.com/development-resources/api-credentials based on the API key you used in the request. You can make this request with any of the Management API roles.No parameters
management_service/post_me_allowed_originsAdds an allowed origin to the list of allowed originshttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins of your API credential. The API key from the request is used to identify the API credentialhttps://docs.adyen.com/development-resources/api-credentials. You can make this request with any of the Management API roles.data: {
. _links
. domain (string)
. id (string)
} (object) required
management_service/delete_me_allowed_origins_by_origin_idRemoves the allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins specified in the path. The API key from the request is used to identify the API credentialhttps://docs.adyen.com/development-resources/api-credentials. You can make this request with any of the Management API roles.originId (string)
management_service/get_me_allowed_origins_by_origin_idReturns the details of the allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins specified in the path. The API key from the request is used to identify the API credentialhttps://docs.adyen.com/development-resources/api-credentials. You can make this request with any of the Management API roles.originId (string)
management_service/post_me_generate_client_keyGenerates a new client keyhttps://docs.adyen.com/development-resources/client-side-authentication/ used to authenticate requests from your payment environment. 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. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writeNo parameters
management_service/get_merchantsReturns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Account readpageNumber (integer)
pageSize (integer)
management_service/post_merchantsCreates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Accounts read and writedata: {
. businessLineId (string)
. companyId (string)
. description (string)
. legalEntityId (string)
. pricingPlan (string)
. reference (string)
. salesChannels (array)
} (object) required
management_service/get_merchants_by_merchant_idReturns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Account readmerchantId (string)
management_service/post_merchants_by_merchant_id_activateSends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a merchant.updatedhttps://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. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, ymerchantId (string)
management_service/get_merchants_by_merchant_id_api_credentialsReturns the list of API credentialshttps://docs.adyen.com/development-resources/api-credentials for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
pageNumber (integer)
pageSize (integer)
management_service/post_merchants_by_merchant_id_api_credentialsCreates an API credentialhttps://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. The response includes the: API keyhttps://docs.adyen.com/development-resources/api-authentication api-key-authentication: used for API request authentication. Client keyhttps://docs.adyen.com/development-resources/client-side-authentication how-it-works: public key used fomerchantId (string)
data: {
. allowedOrigins (array)
. description (string)
. roles (array)
} (object) required
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_idReturns the API credentialhttps://docs.adyen.com/development-resources/api-credentials identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
management_service/patch_merchants_by_merchant_id_api_credentials_by_api_credential_idChanges 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
data: {
. active (boolean)
. allowedOrigins (array)
. description (string)
. roles (array)
} (object) required
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_originsReturns the list of allowed originshttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins for the API credential identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_originsAdds a new allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins to the API credential's list of allowed origins. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
data: {
. _links
. domain (string)
. id (string)
} (object) required
management_service/delete_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_idRemoves the allowed originhttps://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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
originId (string)
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_idReturns the allowed originhttps://docs.adyen.com/development-resources/client-side-authentication allowed-origins identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
originId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_generate_api_keyReturns 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_generate_client_keyReturns a new client keyhttps://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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—API credentials read and writemerchantId (string)
apiCredentialId (string)
management_service/get_merchants_by_merchant_id_billing_entitiesReturns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this emerchantId (string)
name (string)
management_service/get_merchants_by_merchant_id_payment_method_settingsReturns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods readmerchantId (string)
storeId (string)
businessLineId (string)
pageSize (integer)
pageNumber (integer)
management_service/post_merchants_by_merchant_id_payment_method_settingsSends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods read and writemerchantId (string)
data: {
. accel
. affirm
. afterpayTouch
. alipayPlus
. amex
. applePay
. bcmc
. businessLineId (string)
. cartesBancaires
. clearpay
. countries (array)
. cup
. currencies (array)
. customRoutingFlags (array)
. diners
. discover
. eft_directdebit_CA
. eftpos_australia
. girocard
. googlePay
. ideal
. interac_card
. jcb
. klarna
. maestro
. maestro_usa
. mc
. mealVoucher_FR
. nyce
. paybybank_plaid
. payme
. paypal
. payto
. pulse
. reference (string)
. sepadirectdebit
. shopperInteraction (string)
. sodexo
. sofort
. star
. storeIds (array)
. swish
. ticket
. twint
. type (string)
. vipps
. visa
. wechatpay
. wechatpay_pos
} (object) required
management_service/get_merchants_by_merchant_id_payment_method_settings_by_payment_method_idReturns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods readmerchantId (string)
paymentMethodId (string)
management_service/patch_merchants_by_merchant_id_payment_method_settings_by_payment_method_idUpdates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods read and writemerchantId (string)
paymentMethodId (string)
data: {
. accel
. bcmc
. cartesBancaires
. countries (array)
. cup
. currencies (array)
. customRoutingFlags (array)
. diners
. discover
. eft_directdebit_CA
. eftpos_australia
. enabled (boolean)
. girocard
. ideal
. interac_card
. jcb
. maestro
. maestro_usa
. mc
. nyce
. paybybank_plaid
. pulse
. sepadirectdebit
. star
. storeId (string)
. storeIds (array)
. visa
} (object) required
management_service/post_merchants_by_merchant_id_payment_method_settings_by_payment_method_id_add_apple_pay_domainsAdds 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 documentationhttps://docs.adyen.com/payment-methods/apple-pay/web-drop-in/?tab=adyen-certificate-live_1 going-live. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods read and writemerchantId (string)
paymentMethodId (string)
data: {
. domains (array)
} (object) required
management_service/get_merchants_by_merchant_id_payment_method_settings_by_payment_method_id_get_apple_pay_domainsReturns 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 documentationhttps://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay register-merchant-domain. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payment methods readmerchantId (string)
paymentMethodId (string)
management_service/get_merchants_by_merchant_id_payout_settingsReturns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payout account settings readmerchantId (string)
management_service/post_merchants_by_merchant_id_payout_settingsSends 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 instrumenthttps://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. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use thimerchantId (string)
data: {
. enabled (boolean)
. enabledFromDate (string)
. transferInstrumentId (string)
} (object) required
management_service/delete_merchants_by_merchant_id_payout_settings_by_payout_settings_idDeletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payout account settings read and writemerchantId (string)
payoutSettingsId (string)
management_service/get_merchants_by_merchant_id_payout_settings_by_payout_settings_idReturns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payout account settings readmerchantId (string)
payoutSettingsId (string)
management_service/patch_merchants_by_merchant_id_payout_settings_by_payout_settings_idUpdates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Payout account settings read and writemerchantId (string)
payoutSettingsId (string)
data: {
. enabled (boolean)
} (object) required
management_service/get_merchants_by_merchant_id_shipping_locationsReturns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requestsmerchantId (string)
name (string)
offset (integer)
limit (integer)
management_service/post_merchants_by_merchant_id_shipping_locationsCreates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limerchantId (string)
data: {
. address
. contact
. id (string)
. name (string)
} (object) required
management_service/get_merchants_by_merchant_id_split_configurationsReturns the list of split configuration profiles for the merchant account. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
management_service/post_merchants_by_merchant_id_split_configurationsCreates a split configuration profile to split payments automaticallyhttps://docs.adyen.com/platforms/automatic-split-configuration/. After you associate it with a storehttps://docs.adyen.com/api-explorer/Management/latest/patch/merchants/merchantId/stores/storeId request-splitConfiguration in your merchant account, it splits the funds of all transactions processed through that store between your liable balance account and your user's balance accounthttps://docs.adyen.com/api-explorer/ManagementmerchantId (string)
data: {
. description (string)
. rules (array)
. splitConfigurationId (string)
} (object) required
management_service/delete_merchants_by_merchant_id_split_configurations_by_split_configuration_idDeletes the split configuration profile specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
management_service/get_merchants_by_merchant_id_split_configurations_by_split_configuration_idReturns the details of the split configuration profile specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_idChanges the description of the split configuration profile specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
data: {
. description (string)
} (object) required
management_service/post_merchants_by_merchant_id_split_configurations_by_split_configuration_idCreates a rulehttps://docs.adyen.com/platforms/automatic-split-configuration/manage-split-configurations/api/ create-rule in the split configuration profile specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
data: {
. currency (string)
. fundingSource (string)
. paymentMethod (string)
. ruleId (string)
. shopperInteraction (string)
. splitLogic
} (object) required
management_service/delete_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_idDeletes the rule specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
ruleId (string)
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_idChanges the split conditions of the rulehttps://docs.adyen.com/platforms/automatic-split-configuration/manage-split-configurations/api/ update-condition specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
ruleId (string)
data: {
. currency (string)
. fundingSource (string)
. paymentMethod (string)
. shopperInteraction (string)
} (object) required
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_id_split_logic_by_split_logic_idChanges the split logichttps://docs.adyen.com/platforms/automatic-split-configuration/manage-split-configurations/api/ update-split-logic specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API - SplitConfiguration read and writemerchantId (string)
splitConfigurationId (string)
ruleId (string)
splitLogicId (string)
data: {
. acquiringFees (string)
. additionalCommission
. adyenCommission (string)
. adyenFees (string)
. adyenMarkup (string)
. chargeback (string)
. chargebackCostAllocation (string)
. commission
. interchange (string)
. paymentFee (string)
. refund (string)
. refundCostAllocation (string)
. remainder (string)
. schemeFee (string)
. splitLogicId (string)
. surcharge (string)
. tip (string)
} (object) required
management_service/get_merchants_by_merchant_id_storesReturns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-mmerchantId (string)
pageNumber (integer)
pageSize (integer)
reference (string)
management_service/post_merchants_by_merchant_id_storesCreates a store for the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.merchantId (string)
data: {
. address
. businessLineIds (array)
. description (string)
. externalReferenceId (string)
. phoneNumber (string)
. reference (string)
. shopperStatement (string)
. splitConfiguration
. subMerchantData
} (object) required
management_service/get_merchants_by_merchant_id_stores_by_reference_terminal_logosReturns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-crmerchantId (string)
reference (string)
model (string) required
management_service/patch_merchants_by_merchant_id_stores_by_reference_terminal_logosUpdates 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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To change the logo, specify the image file as a Base64-encoded string. To restore the logo inherited from a higher level merchant or company account, specify an empty logo value. TmerchantId (string)
reference (string)
model (string) required
data: {
. data (string)
} (object) required
management_service/get_merchants_by_merchant_id_stores_by_reference_terminal_settingsReturns 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. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and write For sensitive terminal settingshttps:merchantId (string)
reference (string)
management_service/patch_merchants_by_merchant_id_stores_by_reference_terminal_settingsUpdates 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. 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. 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 parametermerchantId (string)
reference (string)
data: {
. cardholderReceipt
. connectivity
. gratuities (array)
. hardware
. localization
. nexo
. offlineProcessing
. opi
. passcodes
. payAtTable
. payment
. receiptOptions
. receiptPrinting
. refunds
. signature
. standalone
. storeAndForward
. surcharge
. tapToPay
. terminalInstructions
. timeouts
. wifiProfiles
} (object) required
management_service/get_merchants_by_merchant_id_stores_by_store_idReturns the details of the store identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.merchantId (string)
storeId (string)
management_service/patch_merchants_by_merchant_id_stores_by_store_idUpdates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.merchantId (string)
storeId (string)
data: {
. address
. businessLineIds (array)
. description (string)
. externalReferenceId (string)
. phoneNumber (string)
. splitConfiguration
. status (string)
. subMerchantData
} (object) required
management_service/get_merchants_by_merchant_id_terminal_logosReturns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This 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. To make this request, your API credential must have one of the following roleshttps://domerchantId (string)
model (string) required
management_service/patch_merchants_by_merchant_id_terminal_logosUpdates 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. This 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. To change the logo, specify the image file as a Base64-encoded string. To restore the logo inherited from the company account, specify an empty logo value. TomerchantId (string)
model (string) required
data: {
. data (string)
} (object) required
management_service/get_merchants_by_merchant_id_terminal_modelsReturns the payment terminal models that the 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. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write ImerchantId (string)
management_service/get_merchants_by_merchant_id_terminal_ordersReturns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-thmerchantId (string)
customerOrderReference (string)
status (string)
offset (integer)
limit (integer)
management_service/post_merchants_by_merchant_id_terminal_ordersCreates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write 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 orderhttps://docs.adyen.com/point-of-sale/managing-terminals/merchantId (string)
data: {
. billingEntityId (string)
. customerOrderReference (string)
. items (array)
. orderType (string)
. shippingLocationId (string)
. taxId (string)
} (object) required
management_service/get_merchants_by_merchant_id_terminal_orders_by_order_idReturns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environmenmerchantId (string)
orderId (string)
management_service/patch_merchants_by_merchant_id_terminal_orders_by_order_idUpdates the terminal products order identified in the path. Updating is only possible while the order has the status Placed. The request body only needs to contain what you want to change. However, to update the products in the items array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must havmerchantId (string)
orderId (string)
data: {
. billingEntityId (string)
. customerOrderReference (string)
. items (array)
. orderType (string)
. shippingLocationId (string)
. taxId (string)
} (object) required
management_service/post_merchants_by_merchant_id_terminal_orders_by_order_id_cancelCancels the terminal products order identified in the path. Cancelling is only possible while the order has the status Placed. To 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. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read and write In the live environment, rmerchantId (string)
orderId (string)
management_service/get_merchants_by_merchant_id_terminal_productsReturns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal ordering read Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/autommerchantId (string)
country (string) required
terminalModelId (string)
offset (integer)
limit (integer)
management_service/get_merchants_by_merchant_id_terminal_settingsReturns 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. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and wrimerchantId (string)
management_service/patch_merchants_by_merchant_id_terminal_settingsUpdates payment terminal settings 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. 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. To restore a parameter value inherited from a higher level, include the full object that contains the parameter, andmerchantId (string)
data: {
. cardholderReceipt
. connectivity
. gratuities (array)
. hardware
. localization
. nexo
. offlineProcessing
. opi
. passcodes
. payAtTable
. payment
. receiptOptions
. receiptPrinting
. refunds
. signature
. standalone
. storeAndForward
. surcharge
. tapToPay
. terminalInstructions
. timeouts
. wifiProfiles
} (object) required
management_service/get_merchants_by_merchant_id_usersReturns a list of users associated with the merchantId specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writemerchantId (string)
pageNumber (integer)
pageSize (integer)
username (string)
management_service/post_merchants_by_merchant_id_usersCreates a user for the merchantId specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writemerchantId (string)
data: {
. accountGroups (array)
. email (string)
. loginMethod (string)
. name
. roles (array)
. timeZoneCode (string)
. username (string)
} (object) required
management_service/get_merchants_by_merchant_id_users_by_user_idReturns user details for the userId and the merchantId specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writemerchantId (string)
userId (string)
management_service/patch_merchants_by_merchant_id_users_by_user_idUpdates user details for the userId and the merchantId specified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Users read and writemerchantId (string)
userId (string)
data: {
. accountGroups (array)
. active (boolean)
. email (string)
. loginMethod (string)
. name
. roles (array)
. timeZoneCode (string)
} (object) required
management_service/get_merchants_by_merchant_id_webhooksLists all webhook configurations for the merchant account. This call does not return webhook configurations for the company account to which the specified merchant account belongs. You can see these in your Customer Area under Developers Webhooks. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read Management API—Webhooks read and writemerchantId (string)
pageNumber (integer)
pageSize (integer)
management_service/post_merchants_by_merchant_id_webhooksSubscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writemerchantId (string)
data: {
. acceptsExpiredCertificate (boolean)
. acceptsSelfSignedCertificate (boolean)
. acceptsUntrustedRootCertificate (boolean)
. active (boolean)
. additionalSettings
. communicationFormat (string)
. description (string)
. encryptionProtocol (string)
. networkType (string)
. password (string)
. populateSoapActionHeader (boolean)
. type (string)
. url (string)
. username (string)
} (object) required
management_service/delete_merchants_by_merchant_id_webhooks_by_webhook_idRemove the configuration for the webhook identified in the path. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writemerchantId (string)
webhookId (string)
management_service/get_merchants_by_merchant_id_webhooks_by_webhook_idReturns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read Management API—Webhooks read and writemerchantId (string)
webhookId (string)
management_service/patch_merchants_by_merchant_id_webhooks_by_webhook_idMake 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. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Webhooks read and writemerchantId (string)
webhookId (string)
data: {
. acceptsExpiredCertificate (boolean)
. acceptsSelfSignedCertificate (boolean)
. acceptsUntrustedRootCertificate (boolean)
. active (boolean)
. additionalSettings
. communicationFormat (string)
. description (string)
. encryptionProtocol (string)
. networkType (string)
. password (string)
. populateSoapActionHeader (boolean)
. url (string)
. username (string)
} (object) required
management_service/post_merchants_by_merchant_id_webhooks_by_webhook_id_generate_hmacReturns an HMAC keyhttps://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 notificationshttps://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures enable-hmac-signatures from Adyen. Find out more about how to verify HMAC signatureshttps://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures. To mamerchantId (string)
webhookId (string)
management_service/post_merchants_by_merchant_id_webhooks_by_webhook_id_testSends sample notifications to test if the webhook is set up correctly. We 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. The 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 tmerchantId (string)
webhookId (string)
data: {
. notification
. types (array)
} (object) required
management_service/get_storesReturns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.pageNumber (integer)
pageSize (integer)
reference (string)
merchantId (string)
management_service/post_storesCreates a store for the merchant account specified in the request. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.data: {
. address
. businessLineIds (array)
. description (string)
. externalReferenceId (string)
. merchantId (string)
. phoneNumber (string)
. reference (string)
. shopperStatement (string)
. splitConfiguration
. subMerchantData
} (object) required
management_service/get_stores_by_store_idReturns the details of the store identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.storeId (string)
management_service/patch_stores_by_store_idUpdates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Stores read and write In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.storeId (string)
data: {
. address
. businessLineIds (array)
. description (string)
. externalReferenceId (string)
. phoneNumber (string)
. splitConfiguration
. status (string)
. subMerchantData
} (object) required
management_service/get_stores_by_store_id_terminal_logosReturns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentialsstoreId (string)
model (string) required
management_service/patch_stores_by_store_id_terminal_logosUpdates 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. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To change the logo, specify the image file as a Base64-encoded string. To restore the logo inherited from a higher level merchant or company account, specify an empty logo value. TstoreId (string)
model (string) required
data: {
. data (string)
} (object) required
management_service/get_stores_by_store_id_terminal_settingsReturns 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. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and write For sensitive terminal settingshttps:storeId (string)
management_service/patch_stores_by_store_id_terminal_settingsUpdates 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. 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. 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 parameterstoreId (string)
data: {
. cardholderReceipt
. connectivity
. gratuities (array)
. hardware
. localization
. nexo
. offlineProcessing
. opi
. passcodes
. payAtTable
. payment
. receiptOptions
. receiptPrinting
. refunds
. signature
. standalone
. storeAndForward
. surcharge
. tapToPay
. terminalInstructions
. timeouts
. wifiProfiles
} (object) required
management_service/get_terminalsReturns the payment terminals that the API credential has access to and that match the query parameters. To make this request, your API credential must have the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API — Terminal actions read In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.searchQuery (string)
otpQuery (string)
countries (string)
merchantIds (string)
storeIds (string)
brandModels (string)
pageNumber (integer)
pageSize (integer)
management_service/post_terminals_schedule_actionsSchedules a terminal actionhttps://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api by specifying the action and the terminals that the action must be applied to. The following restrictions apply: You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. The maximum number of terminals in a request is 100. For example, to apply an action to 250 terminals, you have todata: {
. actionDetails
. scheduledAt (string)
. storeId (string)
. terminalIds (array)
} (object) required
management_service/post_terminals_by_terminal_id_reassignReassigns a payment terminal to a company account, merchant account, merchant account inventory, or a store. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Assign Terminal In the live environment, requests to this endpoint are subject to rate limitshttps://docs.adyen.com/point-of-sale/automating-terminal-management rate-limits-in-the-live-environment.terminalId (string)
data: {
. companyId (string)
. inventory (boolean)
. merchantId (string)
. storeId (string)
} (object) required
management_service/get_terminals_by_terminal_id_terminal_logosReturns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and write In the live environment, requests to this endpoint arterminalId (string)
management_service/patch_terminals_by_terminal_id_terminal_logosUpdates the logo for the payment terminal identified in the path. To change the logo, specify the image file as a Base64-encoded string. To restore the logo inherited from a higher level store, merchant account, or company account, specify an empty logo value. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read and write In the live environment, requests toterminalId (string)
data: {
. data (string)
} (object) required
management_service/get_terminals_by_terminal_id_terminal_settingsReturns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following roleshttps://docs.adyen.com/development-resources/api-credentials api-permissions: Management API—Terminal settings read Management API—Terminal settings read and write For sensitive terminal settingshttps://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api sensitive-terminal-settings, your API creterminalId (string)
management_service/patch_terminals_by_terminal_id_terminal_settingsUpdates the settings that are configured for the payment terminal identified in the path. 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. 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 parameter or omit the parameter. Objects that are not included in the request are not updated. To make this requterminalId (string)
data: {
. cardholderReceipt
. connectivity
. gratuities (array)
. hardware
. localization
. nexo
. offlineProcessing
. opi
. passcodes
. payAtTable
. payment
. receiptOptions
. receiptPrinting
. refunds
. signature
. standalone
. storeAndForward
. surcharge
. tapToPay
. terminalInstructions
. timeouts
. wifiProfiles
} (object) required
notification_configuration_service/post_create_notification_configurationCreates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis as opposed to, for example, a per-account holder basis, so all event notifications of a marketplace and of a given type will be sent to the same endpoints. A marketplace may have multiple endpoints if desired; an event notificationdata: {
. configurationDetails
} (object) required
notification_configuration_service/post_delete_notification_configurationsDeletes an existing notification subscription configuration. After the subscription is deleted, no further event notifications will be sent to the URL defined in the subscription.data: {
. notificationIds (array)
} (object) required
notification_configuration_service/post_get_notification_configurationReturns the details of the configuration of a notification subscription.data: {
. notificationId (integer)
} (object) required
notification_configuration_service/post_get_notification_configuration_listReturns the details of the configurations of all of the notification subscriptions in the platform of the executing user.No parameters
notification_configuration_service/post_test_notification_configurationTests an existing notification subscription configuration. For each event type specified, a test notification will be generated and sent to the URL configured in the subscription specified.data: {
. eventTypes (array)
. notificationId (integer)
} (object) required
notification_configuration_service/post_update_notification_configurationUpdates an existing notification subscription configuration. If you are updating the event types, you must provide all event types, otherwise the previous event type configuration will be overwritten.data: {
. configurationDetails
} (object) required
open_banking_service/post_account_verification_routesCreate a list of routes for verifying bank accounts of third-party individuals. Successful connections generate a unique code used for requesting bank reports and verifying identity.data: {
. country
. locale (string)
. redirectUrl (string)
. state (string)
} (object) required
open_banking_service/get_account_verification_reports_by_codeGet the account verification report using a unique code from a successful open banking connection. This report provides identity verification and bank account details.code (string)
payment_service/post_adjust_authorisationAllows you to increase or decrease the authorised amount after the initial authorisation has taken place. This functionality enables for example tipping, improving the chances your authorisation will be valid, or charging the shopper when they have already left the merchant premises. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce. If you have a newer integrationhttps://docs.adyen.com/online-payments, andata: {
. additionalData (object)
. merchantAccount (string)
. modificationAmount
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_authoriseCreates a payment with a unique reference pspReference and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce. If using a newer integrationhttps://docs.adyen.com/online-payments, use the /paymentsdata: {
. accountInfo
. additionalAmount
. additionalData (object)
. amount
. applicationInfo
. bankAccount
. billingAddress
. browserInfo
. captureDelayHours (integer)
. card
. dateOfBirth (string)
. dccQuote
. deliveryAddress
. deliveryDate (string)
. deviceFingerprint (string)
. entityType (string)
. fraudOffset (integer)
. fundDestination
. fundSource
. fundingSource (string)
. installments
. localizedShopperStatement (object)
. mandate
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. merchantRiskIndicator
. metadata (object)
. mpiData
. nationality (string)
. orderReference (string)
. platformChargebackLogic
. recurring
. recurringProcessingModel (string)
. reference (string)
. secureRemoteCommerceCheckoutData
. selectedBrand (string)
. selectedRecurringDetailReference (string)
. sessionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. socialSecurityNumber (string)
. splits (array)
. store (string)
. telephoneNumber (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
. totalsGroup (string)
. trustedShopper (boolean)
} (object) required
payment_service/post_authorise3dFor an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the md and paResponse parameters that you get from the card issuer after a shopper pays via 3D Secure. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure. If using a newer integrationhttps://docs.adyen.com/online-payments, use the /payments/detailshttps://docs.adyen.com/api-explorer/ /CheckoutSerdata: {
. accountInfo
. additionalAmount
. additionalData (object)
. amount
. applicationInfo
. billingAddress
. browserInfo
. captureDelayHours (integer)
. dateOfBirth (string)
. dccQuote
. deliveryAddress
. deliveryDate (string)
. deviceFingerprint (string)
. fraudOffset (integer)
. installments
. localizedShopperStatement (object)
. mcc (string)
. md (string)
. merchantAccount (string)
. merchantOrderReference (string)
. merchantRiskIndicator
. metadata (object)
. orderReference (string)
. paResponse (string)
. recurring
. recurringProcessingModel (string)
. reference (string)
. selectedBrand (string)
. selectedRecurringDetailReference (string)
. sessionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. socialSecurityNumber (string)
. splits (array)
. store (string)
. telephoneNumber (string)
. threeDS2RequestData
. threeDSAuthenticationOnly (boolean)
. totalsGroup (string)
. trustedShopper (boolean)
} (object) required
payment_service/post_authorise3ds2For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the threeDS2Token and threeDS2Result parameters. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure. If using a newer integrationhttps://docs.adyen.com/online-payments, use the /payments/detailshttps://docs.adyen.com/api-explorer/ /CheckoutService/payments/details endpoint under Checkout API indata: {
. accountInfo
. additionalAmount
. additionalData (object)
. amount
. applicationInfo
. billingAddress
. browserInfo
. captureDelayHours (integer)
. dateOfBirth (string)
. dccQuote
. deliveryAddress
. deliveryDate (string)
. deviceFingerprint (string)
. fraudOffset (integer)
. installments
. localizedShopperStatement (object)
. mcc (string)
. merchantAccount (string)
. merchantOrderReference (string)
. merchantRiskIndicator
. metadata (object)
. orderReference (string)
. recurring
. recurringProcessingModel (string)
. reference (string)
. selectedBrand (string)
. selectedRecurringDetailReference (string)
. sessionId (string)
. shopperEmail (string)
. shopperIP (string)
. shopperInteraction (string)
. shopperLocale (string)
. shopperName
. shopperReference (string)
. shopperStatement (string)
. socialSecurityNumber (string)
. splits (array)
. store (string)
. telephoneNumber (string)
. threeDS2RequestData
. threeDS2Result
. threeDS2Token (string)
. threeDSAuthenticationOnly (boolean)
. totalsGroup (string)
. trustedShopper (boolean)
} (object) required
payment_service/post_cancelCancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures. For more information, refer to Cancelhttps://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce. If using a newer integratdata: {
. additionalData (object)
. merchantAccount (string)
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_cancel_or_refundCancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not for example, when using auto-capture. Do not use this endpoint for payments that involve: Multiple partial captureshttps://docs.adyen.com/online-payments/capture. Split datahttps://docs.adyen.com/classic-platforms/processing-payments providing-split-information either at time of payment or capture for Adyen for Platfodata: {
. additionalData (object)
. merchantAccount (string)
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_captureCaptures the authorisation hold on a payment, returning a unique reference for this request. Usually the full authorisation amount is captured, however it's also possible to capture a smaller amount, which results in cancelling the remaining authorisation balance. Payment methods that are captured automatically after authorisation don't need to be captured. However, submitting a capture request on these transactions will not result in double charges. If immediate or delayed auto-capture is enabdata: {
. additionalData (object)
. merchantAccount (string)
. modificationAmount
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_donateSchedules a new payment to be created including a new authorisation request for the specified donation using the payment details of the original payment. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce. If using a newer integrationhttps://docs.adyen.com/online-payments, use the /donationshttps://docs.adyen.com/api-explorer/ /CheckoutService/latest/post/donations endpoint under Checkout API instead.data: {
. donationAccount (string)
. merchantAccount (string)
. modificationAmount
. originalReference (string)
. platformChargebackLogic
. reference (string)
} (object) required
payment_service/post_get_authentication_resultReturn the authentication result after doing a 3D Secure authentication only.data: {
. merchantAccount (string)
. pspReference (string)
} (object) required
payment_service/post_refundRefunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple partial refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead. Some payment methods/gateways do not support partial/multiple refunds. A margin above the captured limit can be configureddata: {
. additionalData (object)
. merchantAccount (string)
. modificationAmount
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_retrieve3ds2resultRetrieves the threeDS2Result after doing a 3D Secure 2 authentication only.data: {
. merchantAccount (string)
. pspReference (string)
} (object) required
payment_service/post_technical_cancelThis endpoint allows you to cancel a payment if you do not have the PSP reference of the original payment request available. In your call, refer to the original payment by using the reference that you specified in your payment request. For more information, see Technical cancelhttps://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel technical-cancel. This endpoint is part of our classic API integrationhttps://docs.adyen.com/online-payments/classic-integrations/api-data: {
. additionalData (object)
. merchantAccount (string)
. modificationAmount
. mpiData
. originalMerchantReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payment_service/post_void_pending_refundThis endpoint allows you to cancel an unreferenced refund request before it has been completed. In your call, you can refer to the original refund request either by using the tenderReference, or the pspReference. We recommend implementing based on the tenderReference, as this is generated for both offline and online transactions. For more information, refer to Cancel an unreferenced refundhttps://docs.adyen.com/point-of-sale/refund-payment/cancel-unreferenced.data: {
. additionalData (object)
. merchantAccount (string)
. modificationAmount
. mpiData
. originalMerchantReference (string)
. originalReference (string)
. platformChargebackLogic
. reference (string)
. splits (array)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
payments_app_service/post_merchants_by_merchant_id_generate_payments_app_boarding_tokenCreates a boarding token used to authenticate the installation of a Payments App instance on an Android device. The boarding token is created for the boardingRequestToken of the Payments App for the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Adyen Payments App rolemerchantId (string)
data: {
. boardingRequestToken (string)
} (object) required
payments_app_service/post_merchants_by_merchant_id_stores_by_store_id_generate_payments_app_boarding_tokenCreates a boarding token used to authenticate the installation of a Payments App instance on an Android device. The boarding token is created for the boardingRequestToken of the Payments App for the store identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Adyen Payments App rolemerchantId (string)
storeId (string)
data: {
. boardingRequestToken (string)
} (object) required
payments_app_service/get_merchants_by_merchant_id_payments_appsReturns the list of Payments App instances for the merchant account identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Adyen Payments App rolemerchantId (string)
statuses (string)
limit (integer)
offset (integer)
payments_app_service/get_merchants_by_merchant_id_stores_by_store_id_payments_appsReturns the list of Payments App instances for the store identified in the path. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Adyen Payments App rolemerchantId (string)
storeId (string)
statuses (string)
limit (integer)
offset (integer)
payments_app_service/post_merchants_by_merchant_id_payments_apps_by_installation_id_revokeRevokes the authentication of the Payments App instance for the installationId and merchant account identified in the path. This call revokes the authentication of the Payments App instance with the installationId identified in the path for both merchant accounts and stores. To make this request, your API credential must have the following rolehttps://docs.adyen.com/development-resources/api-credentials api-permissions: Adyen Payments App rolemerchantId (string)
installationId (string)
recurring_service/post_create_permitCreate permits for a recurring contract, including support for defining restrictions.data: {
. merchantAccount (string)
. permits (array)
. recurringDetailReference (string)
. shopperReference (string)
} (object) required
recurring_service/post_disableDisables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to Disable stored detailshttps://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/.data: {
. contract (string)
. merchantAccount (string)
. recurringDetailReference (string)
. shopperReference (string)
} (object) required
recurring_service/post_disable_permitDisable a permit that was previously linked to a recurringDetailReference.data: {
. merchantAccount (string)
. token (string)
} (object) required
recurring_service/post_list_recurring_detailsLists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to Retrieve stored detailshttps://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/.data: {
. merchantAccount (string)
. recurring
. shopperReference (string)
} (object) required
recurring_service/post_notify_shopperSends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to Recurring card payments in Indiahttps://docs.adyen.com/payment-methods/cards/cards-recurring-india.data: {
. amount
. billingDate (string)
. billingSequenceNumber (string)
. displayedReference (string)
. merchantAccount (string)
. recurringDetailReference (string)
. reference (string)
. shopperReference (string)
. storedPaymentMethodId (string)
} (object) required
recurring_service/post_schedule_account_updaterWhen making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: If the card information is provided, all the sub-fields for card are mandatory. If the recurring detail reference is provided, the fields for shopperReference and selectedRecurringDetailReference are mandatory.data: {
. additionalData (object)
. card
. merchantAccount (string)
. reference (string)
. selectedRecurringDetailReference (string)
. shopperReference (string)
} (object) required
session_authentication_service/post_sessionsCreates a session token that is required to integrate componentshttps://docs.adyen.com/platforms/components-overview. The response contains encrypted session data. The front end then uses the session data to make the required server-side calls for the component. To create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for Onboardinghttps://docs.adyen.com/platforms/onboard-users/components anddata: {
. allowOrigin (string)
. policy
. product
} (object) required
session_service/post_sessionsEstablishes a secure communications session between the POS Mobile SDK and the Adyen payments platform, through mutual authentication. The request sends a setup token that identifies the SDK and the device. The response returns a session token that the SDK can use to authenticate responses received from the Adyen payments platform. This request applies to mobile in-person transactions. You cannot use this request to create online payments sessions.data: {
. merchantAccount (string)
. setupToken (string)
. store (string)
} (object) required
stored_value_service/post_change_statusChanges the status of the provided payment method to the specified status.data: {
. amount
. merchantAccount (string)
. paymentMethod (object)
. recurringDetailReference (string)
. reference (string)
. shopperInteraction (string)
. shopperReference (string)
. status (string)
. store (string)
} (object) required
stored_value_service/post_check_balanceChecks the balance of the provided payment method.data: {
. amount
. merchantAccount (string)
. paymentMethod (object)
. recurringDetailReference (string)
. reference (string)
. shopperInteraction (string)
. shopperReference (string)
. store (string)
} (object) required
stored_value_service/post_issueIssues a new card of the given payment method.data: {
. amount
. merchantAccount (string)
. paymentMethod (object)
. recurringDetailReference (string)
. reference (string)
. shopperInteraction (string)
. shopperReference (string)
. store (string)
} (object) required
stored_value_service/post_loadLoads the payment method with the specified funds.data: {
. amount
. loadType (string)
. merchantAccount (string)
. paymentMethod (object)
. recurringDetailReference (string)
. reference (string)
. shopperInteraction (string)
. shopperReference (string)
. store (string)
} (object) required
stored_value_service/post_merge_balanceIncreases the balance of the paymentmethod by the full amount left on the source paymentmethoddata: {
. amount
. merchantAccount (string)
. paymentMethod (object)
. recurringDetailReference (string)
. reference (string)
. shopperInteraction (string)
. shopperReference (string)
. sourcePaymentMethod (object)
. store (string)
} (object) required
stored_value_service/post_void_transactionVoids the referenced stored value transaction.data: {
. merchantAccount (string)
. originalReference (string)
. reference (string)
. store (string)
. tenderReference (string)
. uniqueTerminalId (string)
} (object) required
test_card_service/post_create_test_card_rangesCreates one or more test card ranges.data (undefined) required
tfm_api_service/post_assign_terminalsAssigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory. From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management APIhttps://docs.adyen.com/api-explorer/Management/latest/overview.data: {
. companyAccount (string)
. merchantAccount (string)
. merchantInventory (boolean)
. store (string)
. terminals (array)
} (object) required
tfm_api_service/post_find_terminalReturns the company account, merchant account, or store that a payment terminal is assigned to. From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management APIhttps://docs.adyen.com/api-explorer/Management/latest/overview.data: {
. terminal (string)
} (object) required
tfm_api_service/post_get_stores_under_accountReturns a list of stores associated with a company account or a merchant account, including the status of each store. From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management APIhttps://docs.adyen.com/api-explorer/Management/latest/overview.data: {
. companyAccount (string)
. merchantAccount (string)
} (object) required
tfm_api_service/post_get_terminal_detailsReturns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report. From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management APIhttps://docs.adyen.com/api-explorer/Management/latest/overview.data: {
. terminal (string)
} (object) required
tfm_api_service/post_get_terminals_under_accountReturns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store ready for boarding or already boarded. From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management APIhttps://docs.adyen.com/api-explorer/Management/latest/overview.data: {
. companyAccount (string)
. merchantAccount (string)
. store (string)
} (object) required
transaction_service/get_disputes_by_dispute_id_attachmentsGet a list of attachments associated with a dispute ID.disputeId (string)
transaction_service/post_disputes_by_dispute_id_attachmentsAdd supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute.disputeId (string)
data: {
. attachmentType
. content (string)
. fileName (string)
. id (string)
} (object) required
transaction_service/get_disputes_by_dispute_id_attachments_by_attachment_idSearch for a single attachment, providing the specific dispute ID and attachment ID.disputeId (string)
attachmentId (string)
transaction_service/delete_disputes_by_dispute_id_attachments_by_attachment_idRemoves the attachment from the raised dispute. Adyen may keep this file for compliance purposes.disputeId (string)
attachmentId (string)
transaction_service/get_disputesReturns a list of raised disputes that match the query parameters. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.status (string)
paymentInstrument (string)
createdSince (string)
createdUntil (string)
offset (string)
limit (string)
transaction_service/post_disputesRaise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. Raising a dispute returns a dispute ID, which you can use to update details about the dispute, provide supporting documentation, close the dispute, or submit the dispute for a chargeback. You can also use the dispute ID to view the status of the dispute.data: {
. description (string)
. disputedAmount
. duplicateInfo
. fraudInfo
. notDeliveredInfo
. otherInfo
. status
. transactionId (string)
. type
} (object) required
transaction_service/get_disputes_by_idGet a raised dispute by ID.id (string)
transaction_service/patch_disputes_by_idUpdate information related to a raised dispute, or change a dispute's status from draft to submitted or closed. Note: Changing the status of a dispute to submitted or closed is a final action. You cannot make updates to a submitted or closed dispute. Make sure to upload all supporting attachments using the POST /disputes/id/attachments endpoint before you submit a dispute. When you update a dispute to submitted, Adyen sends the raised dispute to the card scheme for review and acquirer defense.id (string)
data: {
. duplicateInfo (object)
. fraudInfo (object)
. notDeliveredInfo (object)
. otherInfo (object)
. status (object)
} (object) required
transfer_service/get_grantsReturns a list of grants with status and outstanding balances.counterpartyAccountHolderId (string)
transfer_service/post_grantsRequests the payout of the selected grant offer.Idempotency-Key (string)
data: {
. counterparty
. grantAccountId (string)
. grantOfferId (string)
} (object) required
transfer_service/get_grants_by_idReturns the details of a capital account specified in the path.id (string)
transfer_service/get_transactionsVersions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - balanceAccountId - accountHolderId - balancePlatform. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages whbalancePlatform (string)
paymentInstrumentId (string)
accountHolderId (string)
balanceAccountId (string)
cursor (string)
createdSince (string) required
createdUntil (string) required
sortOrder (string)
limit (integer)
transfer_service/get_transactions_by_idVersions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.id (string)
transfer_service/get_transfersReturns all the transfers related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - balanceAccountId - accountHolderId - balancePlatform. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results.balancePlatform (string)
accountHolderId (string)
balanceAccountId (string)
paymentInstrumentId (string)
reference (string)
category (string)
createdSince (string) required
createdUntil (string) required
sortOrder (string)
cursor (string)
limit (integer)
transfer_service/post_transfersVersions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - Balance accountshttps://docs.adyen.com/api-explorer/ /balanceplatform/latest/post/balanceAccounts - Transfer instrumentshttps://docs.adyen.com/api-explorer/ /legalentity/latest/post/transferInstruments - Third-party bank accountshttps://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts - Third-party cardshttps://docs.adIdempotency-Key (string)
WWW-Authenticate (string)
data: {
. amount
. balanceAccountId (string)
. category (string)
. counterparty
. description (string)
. executionDate
. paymentInstrumentId (string)
. priorities (array)
. priority (string)
. reference (string)
. referenceForBeneficiary (string)
. review
. type (string)
. ultimateParty
} (object) required
transfer_service/post_transfers_approveInitiates the approval of a list of transfers that triggered an additional reviewhttps://docs.adyen.com/api-explorer/transfers/latest/post/transfers request-review. Adyen sends the outcome of the approval request through webhooks. To use this endpoint: - Your API credential must have the TransferService Approve rolehttps://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3. - The account holder must have the required capabilitieshttps://docs.adyen.com/platforms/verificatioIdempotency-Key (string)
WWW-Authenticate (string)
data: {
. transferIds (array)
} (object) required
transfer_service/post_transfers_cancelInitiates the cancellation of a list of transfers that triggered an additional reviewhttps://docs.adyen.com/api-explorer/transfers/latest/post/transfers request-review. Adyen sends the outcome of the cancel request through webhooks. To use this endpoint: - Your API credential must have the TransferService Approve rolehttps://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3. - The account holder must have the required capabilitieshttps://docs.adyen.com/platforms/verificatIdempotency-Key (string)
data: {
. transferIds (array)
} (object) required
transfer_service/get_transfers_by_idReturns the details of a specified transfer.id (string)
transfer_service/post_transfers_by_transfer_id_returnsInitiates the return of previously transferred funds without creating a new transferId.transferId (string)
Idempotency-Key (string)
data: {
. amount
. reference (string)
} (object) required