Adyen
API integration

list_all_adyen_companies

List Adyen company accounts that your API credential has access to. Returns: _links, dataCenters, description, id, name, reference, status. Max 100 per page.

get_single_adyen_company_by_id

Get a single Adyen company account by id. Returns: _links, dataCenters, description, id, name, reference, status. Required: id.

adyen_companies_attach_webhook

Set up a webhook for an Adyen company account to receive notifications about events related to the account. Returns the created webhook configuration with id, type, url, active, and communicationFormat. Required: company_id, company_id, active, communicationFormat, filterMerchantAccountType, filterMerchantAccounts, type, url.

adyen_companies_list_webhooks

List all webhook configurations for an Adyen company account. Returns webhooks with id, type, url, active, and communicationFormat. Required: company_id.

list_all_adyen_users

List the users of an Adyen company account. Returns: _links, accountGroups, active, apps, associatedMerchantAccounts, email, id, name, roles, timeZoneCode, username. Required: company_id.

get_single_adyen_user_by_id

Get the details of a single Adyen company user by id. Returns: _links, accountGroups, active, apps, associatedMerchantAccounts, email, id, name, roles, timeZoneCode, username. Required: company_id, id.

create_a_adyen_user

Create a new user under a company in Adyen. Returns the created user with id, email, username, name, roles, and timeZoneCode. Requires company_id, email, name, and username. Required: company_id, email, name, username.

update_a_adyen_user_by_id

Update a user's details in Adyen by id. Returns the updated user with id, email, username, name, roles, and timeZoneCode. Requires company_id and id. Required: id, company_id.

list_all_adyen_me

Get the Adyen API credential details corresponding to the API key used in the request. Returns: _links, active, allowedIpAddresses, allowedOrigins, clientKey, companyName, description, id, roles, subjectDN, username.

create_a_adyen_adjust_authorisation

Adjust the authorised amount of a payment in Adyen by increasing or decreasing it after the initial authorisation (e.g. for tipping). Returns: additionalData, pspReference, response. Required: merchantAccount, modificationAmount, originalReference. Deprecated for new integrations; use the Checkout API amountUpdates endpoint instead.

create_a_adyen_apple_pay_session

Create an Apple Pay session in Adyen for an API-only Apple Pay integration using Adyen's certificate. Returns: data. Required: displayName, domainName, merchantIdentifier.

list_all_adyen_authentication_result

Get the 3D Secure authentication result in Adyen after completing a 3DS1 or 3DS2 authentication. Returns: threeDS1Result, threeDS2Result. Required: merchantAccount, pspReference.

create_a_adyen_authorise_3_d

Complete a 3D Secure payment authorisation in Adyen by submitting the issuer result for an authenticated 3DS session. Returns: authCode, dccAmount, issuerUrl, md, paRequest, and 6 more. Required: merchantAccount, md, paResponse. Deprecated — this endpoint is inactive for new integrations; use the Checkout API /payments/details endpoint instead.

create_a_adyen_authorise_3_ds_2

Complete a 3DS2 payment authorisation in Adyen for an authenticated 3D Secure 2 session. Returns: authCode, pspReference, refusalReason, and 8 more. This endpoint is inactive and no longer supported for new integrations; use the Checkout API /payments/details instead. Required: amount, merchantAccount, reference.

create_a_adyen_authoris

Create a payment authorisation in Adyen and attempt to obtain an authorisation hold. Returns: additionalData, authCode, dccAmount, fraudResult, pspReference, refusalReason, resultCode, and 4 more. Requires amount, merchantAccount, and reference. Deprecated: no longer supported for new integrations — use the Checkout API /payments endpoint instead.

create_a_adyen_calculate_tax

Calculate the tax for a transaction in Adyen, such as the India Liberalised Remittance Scheme Tax Collected at Source. Returns: taxCalculation, taxCalculationReference, taxCalculationToken. Required: merchantAccount, taxCalculationContext, taxableAmount. Submit the token in /payments using taxCalculation.totalAmount as the amount.

create_a_adyen_cancel_or_refund

Cancel or refund a payment in Adyen — cancels it if not yet captured, or refunds it if already captured. Returns: additionalData, pspReference, response. Required: merchantAccount, originalReference. Not for payments with multiple partial captures or split data; inactive for new integrations (use the Checkout API reversals endpoint instead).

create_a_adyen_cancel

Cancel the authorisation on an Adyen payment that has not yet been captured. Returns: merchantAccount, paymentReference, pspReference, reference, status. Required: merchantAccount, paymentReference. The outcome arrives asynchronously via a TECHNICAL_CANCEL webhook.

create_a_adyen_cancels_cancel

Cancel an authorisation in Adyen, submitting a cancellation request for a previously authorised payment before it is captured. Returns: additionalData, pspReference, response. Required: merchantAccount, originalReference.

create_a_adyen_capture

Capture an authorisation hold on a payment in Adyen, optionally capturing a smaller amount and cancelling the remaining authorisation balance. Returns: additionalData, pspReference, response. Required: merchantAccount, modificationAmount, originalReference. Inactive for new integrations — use the Checkout API captures endpoint instead.

create_a_adyen_card_detail

Get the brands and other details of a card in Adyen to decide transaction routing and eligibility, including co-badged card detection. Returns: brands, fundingSource, isCardCommercial, issuingCountryCode. Required: merchantAccount.

create_a_adyen_create_permit

Create new permits linked to a recurring contract in Adyen, with support for defining restrictions. Returns: permitResultList, pspReference. Required: merchantAccount, permits, recurringDetailReference, shopperReference.

create_a_adyen_disable

Disable a shopper's stored payment details in Adyen to stop future charges for a specific recurring detail ID. Returns: response. Required: merchantAccount, shopperReference.

create_a_adyen_donate

Create a donation in Adyen by scheduling a new payment (including authorisation) using the payment details of the original payment. Returns: additionalData, pspReference, response. Required: donationAccount, merchantAccount, modificationAmount. Inactive endpoint — new integrations must use the Checkout API /donations endpoint instead.

create_a_adyen_donation_campaign

Query the donation campaigns available in Adyen for a given donation context; only active campaigns are returned. Returns donationCampaigns, an array of campaigns with id, campaignName, donation details, and nonprofit info. Required: merchantAccount, currency.

create_a_adyen_donation

Make a donation in Adyen using the donation token generated by a /payments request. Returns: amount, donationAccount, id, merchantAccount, payment, reference, status. Requires amount, merchantAccount, reference, and returnUrl. Required: amount, merchantAccount, reference, returnUrl.

create_a_adyen_forward

Forward Adyen-stored payment details (card details or network tokens) to a third party you specify and return the third party's response. Returns: accountUpdate, merchantReference, networkToken, pspReference, response, storedPaymentMethodId. Required: baseUrl, merchantAccount, request, request.body, request.httpMethod, shopperReference.

create_a_adyen_order

Create an order in Adyen to be used for partial payments, and call it before making payments with different payment methods. Returns: additionalData, amount, expiresAt, fraudResult, orderData, pspReference, reference, refusalReason, remainingAmount, resultCode. Required: amount, merchantAccount, reference.

create_a_adyen_orders_cancel

Cancel an Adyen order, which automatically rolls back all payments made in the order by canceling or refunding them depending on the payment method. Returns: pspReference, resultCode. Required: merchantAccount, order.

create_a_adyen_origin_key

Create Adyen origin keys for the given origin domains. Returns: originKeys. Adyen recommends migrating to client keys instead of origin keys. Required: originDomains.

create_a_adyen_payment_amount_update

Update an authorised Adyen payment amount up or down. Returns: amount, paymentPspReference, pspReference, reference, status, and 5 more. The outcome is delivered asynchronously via an AUTHORISATION_ADJUSTMENT webhook; only uncaptured authorised amounts can be updated. Required: payment_psp_reference, amount, merchantAccount.

create_a_adyen_payment_cancel

Cancel an authorised payment in Adyen that has not yet been captured. Returns: merchantAccount, paymentPspReference, pspReference, reference, status. The final outcome is delivered asynchronously via a CANCELLATION webhook. Required: payment_psp_reference, merchantAccount.

create_a_adyen_payment_capture

Capture an authorised Adyen payment, either the full amount or a partial capture. Returns: amount, lineItems, merchantAccount, paymentPspReference, platformChargebackLogic, and 4 more fields. Required: payment_psp_reference, amount, merchantAccount. The capture outcome is delivered asynchronously via a CAPTURE webhook.

create_a_adyen_payment_link

Create an Adyen payment link pointing to a Pay by Link page where the shopper can pay; the payment methods presented depend on the currency and country sent. Returns: allowedPaymentMethods, amount, applicationInfo, billingAddress, blockedPaymentMethods, captureDelayHours, id, status, url, and 37 more. Required: amount, merchantAccount, reference.

get_single_adyen_payment_link_by_id

Get the details of an Adyen payment link by id. Returns: allowedPaymentMethods, amount, applicationInfo, billingAddress, blockedPaymentMethods, captureDelayHours, countryCode, dateOfBirth, deliverAt, deliveryAddress, description, expiresAt, fundOrigin, fundRecipient, id, installmentOptions, reference, status, url, and 27 more. Required: id.

update_a_adyen_payment_link_by_id

Update the status of an Adyen payment link by id, for example to force the link's expiry. Returns: allowedPaymentMethods, amount, applicationInfo, billingAddress, blockedPaymentMethods, captureDelayHours, countryCode, dateOfBirth, deliverAt, deliveryAddress, description, expiresAt, fundOrigin, id, status, url, and 30 more. Required: id, status.

create_a_adyen_payment_method

Retrieve the list of available payment methods for a transaction in Adyen, filtered by transaction details like amount, country, and currency. Returns: paymentMethods, storedPaymentMethods. Required: merchantAccount.

create_a_adyen_payment_methods_balance

Get the remaining balance of a shopper's gift card in Adyen. Returns: additionalData, balance, fraudResult, pspReference, refusalReason, resultCode, transactionLimit. Required: amount, merchantAccount, paymentMethod.

create_a_adyen_payment_refund

Refund a captured Adyen payment, in full or partially; the outcome is delivered asynchronously via a REFUND webhook. Returns: amount, capturePspReference, lineItems, merchantAccount, payment_psp_reference, pspReference, reference, status, store, and 2 more. Required: payment_psp_reference, payment_psp_reference, amount, merchantAccount.

create_a_adyen_payment_reversal

Reverse an Adyen payment: refunds it if already captured, cancels it if not yet captured. Returns: merchantAccount, payment_psp_reference, pspReference, reference, status. Reverses the full payment amount; outcome arrives asynchronously via a CANCEL_OR_REFUND webhook. Required: payment_psp_reference, payment_psp_reference, merchantAccount.

create_a_adyen_payment

Start a payment transaction in Adyen by submitting the shopper's payment parameters such as amount, currency, and payment method. For a direct flow the response carries the payment result; for redirects or additional actions it includes an action object. Returns: action, additionalData, amount, and 2 more fields. Required: amount, merchantAccount,…

create_a_adyen_payments_detail

Submit payment details for an Adyen payment that has not yet reached a final state, for example when the shopper was redirected to another page to complete the payment. Returns: action, additionalData, amount, donationToken, fraudResult, merchantReference, opi, order, pspReference, refusalReason, resultCode, and 7 more. Required: details.

create_a_adyen_payments_details_payment

Submit payment details to Adyen to complete a payment initiated earlier, such as after a 3D Secure challenge or redirect. Returns: action, additionalData, amount, donationToken, fraudResult, merchantReference, opi, order, paymentMethod, paymentValidations, pspReference, refusalReason, refusalReasonCode, resultCode, and 4 more. Required: details.

create_a_adyen_payments_payment

Create a synchronous payment request on a specific Adyen payment terminal. Returns: Response, SaleData, POIData, PaymentResult, LoyaltyResult, PaymentReceipt. Required: merchant_account, device_id, SaleData, PaymentTransaction.

create_a_adyen_paypal_update_order

Update a PayPal Express Checkout order in Adyen to refresh the PayPal lightbox with an updated amount and delivery methods based on the delivery address. Returns the regenerated paymentData to carry into the subsequent payment request and the status of the update (success or error).

create_a_adyen_refund

Refund a captured Adyen payment in full or partially. Returns: additionalData, pspReference, response. Required: merchantAccount, modificationAmount, originalReference. Inactive for new integrations; use the Checkout API refunds endpoint instead.

create_a_adyen_retrieve_3_ds_2_result

Retrieve the 3DS2 authentication result from Adyen after completing a 3D Secure 2 authentication-only flow. Returns: threeDS2Result. Required: merchantAccount, pspReference.

create_a_adyen_session

Create an Adyen payment session for Drop-in, Components, or Hosted Checkout. Returns: accountInfo, additionalAmount, additionalData, allowedPaymentMethods, amount, expiresAt, id, sessionData, and 59 more. Required: amount, merchantAccount, reference, returnUrl. Payment outcome is delivered asynchronously via an AUTHORISATION webhook.

get_single_adyen_session_by_id

Get the result of an Adyen payment session by id. Returns: additionalData, id, payments, reference, status. Required: id, sessionId, sessionResult.

update_a_adyen_session_by_id

Update an Adyen payment session by id. Returns: sessionData. Required: id, amount, sessionData. Only amount and payable can be changed, and only while the session is not yet payable.

create_a_adyen_sessions_v_1

Create a payment session in Adyen. Returns the session details including id, sessionData, and expiresAt. Required: merchantAccount, amount, reference, and returnUrl.

create_a_adyen_sessions_v_68

Create a payment session in Adyen Checkout. Returns the session object including id, sessionData, expiresAt, amount, and merchantAccount. Required: amount, merchantAccount, reference, returnUrl.

adyen_shopper_ids_validate

Validate a shopper ID in Adyen. Returns: reason, result. Required: merchantAccount, paymentMethod.

adyen_shopper_tax_identifications_verify

Verify a shopper's tax identification in Adyen for regulatory compliance. Returns: reason, reasonCode, result, taxVerificationReference, verifiedShopperTaxIdentification, and 1 more field. Required: merchantAccount, shopperReference, shopperTaxIdentification. Requires merchantAccount, shopperReference, and shopperTaxIdentification.

create_a_adyen_stored_payment_method

Create a token to store an Adyen shopper's payment details for use in future payments. Returns: alias, aliasType, billingAddress, brand, cardBin, createdAt, expiryMonth, expiryYear, externalResponseCode, holderName, id, shopperReference, type, and 12 more. Required: merchantAccount, paymentMethod, recurringProcessingModel, shopperReference.

delete_a_adyen_stored_payment_method_by_id

Delete a token for stored payment details in Adyen by id; the token can no longer be used with payment requests. Returns an empty 204 response on success. Required: id, shopperReference, merchantAccount, storedPaymentMethodId.

list_all_adyen_stored_payment_methods

List the tokens for a shopper's stored payment details in Adyen, with a summary of the stored details. Returns: alias, aliasType, billingAddress, brand, cardBin, createdAt, expiryMonth, expiryYear, externalResponseCode, holderName, id, lastFour, shopperReference, type, and 11 more. Filter by shopperReference and merchantAccount.

create_a_adyen_technical_cancel

Cancel an Adyen payment authorisation using your original payment reference when the PSP reference is unavailable. Returns: additionalData, pspReference, response. Requires merchantAccount and originalMerchantReference. Inactive for new integrations; use the Checkout API /cancels endpoint instead. Required: merchantAccount,…

create_a_adyen_void_pending_refund

Cancel a pending in-person refund in Adyen before it completes, referencing the original refund request by tenderReference or pspReference. Returns: additionalData, pspReference, response. Required: merchantAccount.

create_a_adyen_allowed_origin

Add an allowed origin to your Adyen API credential's list of allowed origins for client-side authentication. Returns the created origin including its id, domain, and _links. Required: domain.

delete_a_adyen_allowed_origin_by_id

Remove an allowed origin from your Adyen API credential by id. Returns an empty 204 response on success. Required: id.

get_single_adyen_allowed_origin_by_id

Get the details of a single allowed origin of your Adyen API credential by id. Returns the origin's id, domain, and _links. Required: id.

list_all_adyen_allowed_origins

List the allowed origins registered on your Adyen API credential for client-side authentication. Returns each allowed origin with its unique identifier (id).

create_a_adyen_allowed_origins_allowedorigin

Create an allowed origin for an Adyen API credential. Returns the created origin including its domain, id, and _links. Required: company_id, api_credential_id, domain.

delete_a_adyen_allowed_origins_allowedorigin_by_id

Delete an allowed origin from an Adyen company-level API credential. Once removed, Adyen no longer accepts client-side requests from that origin. Returns an empty 204 response on success. Required: company_id, api_credential_id, id.

get_single_adyen_allowed_origins_allowedorigin_by_id

Get an allowed origin of an Adyen API credential by id. Returns: _links, domain, id. Required: id, company_id, api_credential_id.

list_all_adyen_allowed_origins_allowedorigins

List the allowed origins configured on an Adyen API credential under a company account. Returns the list of allowed origin records, each with its id. Required: company_id, api_credential_id.

create_a_adyen_companie_android_app

Upload an Android APK file to Adyen for a company account. Returns the unique app id. Max APK file size 200 MB. Required: company_id, company_id.

get_single_adyen_companie_android_app_by_id

Get the details of a single Android app uploaded to Adyen. Returns: description, errorCode, errors, id, label, packageName, status, versionCode, versionName, BasicAuth. Required: id, company_id.

list_all_adyen_companie_android_apps

List the Android apps available for a company account in Adyen. Returns: description, errorCode, errors, id, label, packageName, status, versionCode, versionName. Max 100 per page. Required: company_id.

update_a_adyen_companie_android_app_by_id

Reprocess a previously uploaded Android app in Adyen by reuploading it. Returns: Message, BasicAuth. Required: id, company_id.

create_a_adyen_companie_android_certificate

Upload an Android certificate file to Adyen so it can be installed on Android payment terminals. Returns a JSON confirmation of the certificate upload. Subject to rate limits in the live environment. Required: company_id.

list_all_adyen_companie_android_certificates

List the Android certificates available for an Adyen company account, used to run apps on Android payment terminals. Returns: description, extension, id, name, notAfter, notBefore, status. Max 100 per page. Required: company_id.

create_a_adyen_companie_api_credential

Create an API credential for an Adyen company account, optionally specifying its roles, allowed origins, and associated merchant accounts. Returns: _links, active, allowedOrigins, apiKey, clientKey, id, password, roles, and 5 more. The API key is shown only once — store it securely, it cannot be retrieved later. Required: company_id, company_id.

get_single_adyen_companie_api_credential_by_id

Get a single Adyen API credential by id. Returns: _links, active, allowedIpAddresses, allowedOrigins, associatedMerchantAccounts, clientKey, description, id, roles, subjectDN, username. Required: id, company_id, apiCredentialId.

list_all_adyen_companie_api_credentials

List Adyen API credentials for a company account. Returns: _links, active, allowedIpAddresses, allowedOrigins, associatedMerchantAccounts, clientKey, description, id, roles, subjectDN, username. Max 100 per page. Required: company_id.

update_a_adyen_companie_api_credential_by_id

Update an Adyen API credential's roles, allowed origins, description, or merchant account access by id. Returns the full updated credential: id, username, clientKey, roles, active. Required: id, company_id, apiCredentialId.

list_all_adyen_companie_billing_entities

List the billing entities of an Adyen company account and all merchant accounts belonging to it. Returns: address, email, id, name, taxId. Required: company_id.

list_all_adyen_companie_merchants

List merchant accounts under a company account in Adyen. Returns: _links, captureDelay, companyId, dataCenters, defaultShopperInteraction, description, id, merchantCity, name, pricingPlan, primarySettlementCurrency, reference, shopWebAddress, status. Max 100 per page. Required: company_id.

create_a_adyen_companie_shipping_location

Create a shipping location for an Adyen company account, defining an address where orders can be delivered. Returns the created location including its id, name, address, and contact. Required: company_id.

list_all_adyen_companie_shipping_locations

List shipping locations for an Adyen company account and all merchant accounts belonging to it. Returns: address, contact, id, name. Required: company_id.

get_single_adyen_companie_terminal_action_by_id

Get a single terminal action scheduled for a company account in Adyen. Returns: actionType, config, confirmedAt, id, result, scheduledAt, status, terminalId. Required: id, company_id, actionId.

list_all_adyen_companie_terminal_actions

List terminal actions scheduled for a company account in Adyen. Returns: actionType, config, confirmedAt, id, result, scheduledAt, status, terminalId. Actions scheduled by Adyen are not included. Required: company_id.

adyen_companie_terminal_logos_bulk_update

Update the terminal logo for a specific payment terminal model at an Adyen company account. Returns: data. Applies company-wide unless overridden at a lower level. Required: company_id, model.

list_all_adyen_companie_terminal_logos

Get the terminal logo configured for a specific payment terminal model at an Adyen company account. Returns the logo as a Base64-encoded image string in data; Base64-decode it to get the actual image file. Required: company_id, model, company_id.

list_all_adyen_companie_terminal_models

List the payment terminal models that a company account in Adyen has access to. Returns terminal model records with their id (for example, Verifone.M400), which can be used as a query parameter when listing terminals or ordering products. Required: company_id.

adyen_companie_terminal_orders_cancel

Cancel a terminal products order in Adyen. Returns the cancelled order including its id, status, and customerOrderReference. Only orders with status Placed can be cancelled. Required: company_id, order_id.

create_a_adyen_companie_terminal_order

Create an Adyen order for payment terminal products under a company account. Returns: billingEntity, customerOrderReference, id, items, orderDate, shippingLocation, status, trackingUrl. Required: company_id.

get_single_adyen_companie_terminal_order_by_id

Get an Adyen terminal products order by id. Returns: billingEntity, customerOrderReference, id, items, orderDate, shippingLocation, status, trackingUrl. Required: id, company_id, orderId.

list_all_adyen_companie_terminal_orders

List Adyen terminal products orders for a company account. Returns: billingEntity, customerOrderReference, id, items, orderDate, shippingLocation, status, trackingUrl. Required: company_id.

update_a_adyen_companie_terminal_order_by_id

Update an Adyen terminal products order by id. Returns: billingEntity, customerOrderReference, id, items, orderDate, shippingLocation, status, trackingUrl. Updating is only possible while the order status is Placed. Required: id, company_id, orderId.

list_all_adyen_companie_terminal_products

List the country-specific payment terminal packages and parts available to a company account. Returns: description, id, itemsIncluded, name, price. Required: company_id, country.

list_all_adyen_companie_terminal_settings

Get the Adyen payment terminal settings configured for a company account. Returns: cardholderReceipt, connectivity, dcc, gratuities, hardware, homeScreen, kioskMode, localization, moto, nexo, offlineProcessing, opi, passcodes, payment, receiptPrinting, refunds, standalone, surcharge, wifiProfiles, and 8 more. Required: company_id, company_id.

adyen_companie_terminal_settings_bulk_update

Update the payment terminal settings for a company account in Adyen. Returns the updated settings including cardholderReceipt, connectivity, dcc, gratuities, payment, and wifiProfiles. Required: company_id.

create_a_adyen_confirm_third_party

Confirm a previously submitted third-party payout in Adyen. Returns: additionalData, pspReference, response. Required: merchantAccount, originalReference. Deprecated - no longer supports new integrations; use the Transfers API instead.

list_all_adyen_cost_estimate

Get a pre-authorization cost estimate for interchange and scheme fees for a transaction in Adyen. Returns: cardBin, costEstimateAmount, costEstimateReference, resultCode. Requires amount and merchantAccount. Only available for merchants operating in Australia, the EU, and the UK. Required: amount, merchantAccount.

create_a_adyen_decline_third_party

Cancel a previously submitted third-party payout in Adyen. Returns: additionalData, pspReference, response. Requires merchantAccount and originalReference. Deprecated — use the Transfers API for new integrations. Required: merchantAccount, originalReference.

create_a_adyen_disable_permit

Disable an existing Adyen permit that was previously linked to a recurring detail reference. Returns: pspReference, status. Required: merchantAccount, token.

create_a_adyen_generate_api_key

Generate a new API key for a company-level API credential in Adyen. Returns: apiKey, BasicAuth. The new key is usable a few minutes after generation and the old key stops working 24 hours later. Required: company_id, api_credential_id.

create_a_adyen_generate_api_keys_generateapikey

Generate a new API key for an API credential in Adyen. Returns: apiKey. The new key becomes usable within a few minutes and the previous key stops working after 24 hours. Required: merchant_id, api_credential_id.

create_a_adyen_generate_client_key

Generate a new Adyen client key for authenticating requests from your payment environment. Returns: clientKey. The new key becomes usable within a few minutes and the old key stops working 24 hours after generation.

create_a_adyen_generate_client_keys_generateclientkey

Generate a new client key for an API credential in an Adyen company account. Returns: clientKey. The new key becomes usable a few minutes after generation and the previous one stops working 24 hours later. Required: company_id, api_credential_id.

create_a_adyen_get_3_ds_availability

Check whether 3D Secure is available for a specified BIN or card brand in Adyen. Returns: binDetails, dsPublicKeys, threeDS1Supported, threeDS2CardRangeDetails, threeDS2supported. Required: merchantAccount. For 3D Secure 2, also returns device fingerprinting keys.

create_a_adyen_notify_shopper

Ask the issuer to notify the shopper about an upcoming recurring payment in Adyen; used only for local acquiring in India. Returns: displayedReference, message, pspReference, reference, resultCode, and 2 more fields. Required: amount, merchantAccount, reference, shopperReference. Requires amount, merchantAccount, reference, and shopperReference.

create_a_adyen_payout

Make an instant card payout in Adyen, with funds available within 30 minutes on the cardholder's account. Returns: authCode, pspReference, refusalReason, resultCode, and 7 more. Required: amount, merchantAccount, reference. Deprecated: use the Transfers API for new integrations; instant payouts support Visa and Mastercard cards only.

list_all_adyen_recurring_details

List the payment details stored for a shopper in Adyen; each returned detail's ID can be used with a regular authorisation request to charge the shopper later. Returns: creationDate, details, lastKnownShopperEmail, shopperReference. Required: merchantAccount, shopperReference.

create_a_adyen_schedule_account_updater

Schedule running the Adyen Account Updater to check a stored payment method for updated card information. Returns: pspReference, result. Required: merchantAccount, reference. Provide either the full card details, or shopperReference with selectedRecurringDetailReference.

create_a_adyen_store_detail_and_submit_third_party

Store details and submit a third-party payout in Adyen; the payout must then be confirmed or declined. Deprecated for new integrations — use the Transfers API instead. Returns: additionalData, pspReference, refusalReason, and 1 more field. Required: amount, dateOfBirth, entityType, merchantAccount, nationality, recurring, reference, shopperEmail,…

create_a_adyen_store_detail

Store payout details in Adyen under the PAYOUT recurring contract for later payout submissions via /submitThirdParty. Deprecated: use the Transfers API for new integrations. Returns: additionalData, pspReference, recurringDetailReference, 1 more.

create_a_adyen_submit_third_party

Submit an Adyen third-party payout using stored payment details. Deprecated: use the Transfers API for new integrations. Returns: additionalData, pspReference, refusalReason, 1 more. Required: amount, merchantAccount, recurring, reference, shopperEmail, shopperReference, selectedRecurringDetailReference.

list_all_adyen_merchants

List Adyen merchant accounts that your API credential has access to. Returns each merchant's id, name, companyId, status, reference, and description. Max 100 items per page.

adyen_merchants_activate

Request activation of an Adyen merchant account. Returns an acknowledgment object (id, attributes) confirming the activation request was accepted; the activation result is delivered asynchronously via the merchant.updated webhook. Required: merchant_id.

adyen_merchants_attach_webhook

Set up a webhook for an Adyen merchant account to receive event notifications about that account. Returns the webhook configuration including id, url, type, active, communicationFormat, username, and hasPassword. Required: merchant_id, merchant_id, active, communicationFormat, type, url.

create_a_adyen_merchant

Create an Adyen merchant account for a company account; intended for integrations like Adyen for Platforms Manage where access is arranged by your Adyen contact. Returns: businessLineId, companyId, description, id, legalEntityId, pricingPlan, reference. Required: companyId.

get_single_adyen_merchant_by_id

Get a single Adyen merchant account by id. Returns the merchant object including id, name, companyId, status, captureDelay, merchantCity, primarySettlementCurrency, and shopWebAddress. Required: id.

adyen_merchants_list_webhooks

List all webhook configurations for an Adyen merchant account. Returns: id, type, url, active, communicationFormat, username. Webhooks configured on the parent company account are excluded; page size defaults to 10 (max 100). Required: merchant_id.

delete_a_adyen_companie_webhook_by_id

Remove the configuration for a webhook in Adyen. Returns an empty 204 response on success. Required: id, company_id, webhookId.

get_single_adyen_companie_webhook_by_id

Get the configuration of a specific webhook for a company account in Adyen. Returns the webhook object including id, url, active, communicationFormat, type, and username. Required: id, company_id, company_id, webhookId.

update_a_adyen_companie_webhook_by_id

Update the configuration of a specific webhook for a company account in Adyen. Returns the full updated webhook object including id, url, active, communicationFormat, type, and username. Required: id, company_id, company_id, webhookId.

create_a_adyen_merchant_api_credential

Create an Adyen API credential for a merchant account, optionally specifying roles, description, and allowedOrigins. Returns: _links, active, allowedIpAddresses, allowedOrigins, apiKey, clientKey, description, id, password, roles, subjectDN, username. The apiKey is only shown once and cannot be retrieved later. Required: merchant_id.

get_single_adyen_merchant_api_credential_by_id

Get a single Adyen API credential by id for a merchant account. Returns: _links, active, allowedIpAddresses, allowedOrigins, clientKey, description, id, roles, subjectDN, username. Required: id, merchant_id, apiCredentialId.

list_all_adyen_merchant_api_credentials

List Adyen API credentials for a merchant account. Returns each credential's: id, username, clientKey, description, roles, active. Max 100 per page. Required: merchant_id.

update_a_adyen_merchant_api_credential_by_id

Update an Adyen API credential's roles, allowedOrigins, description, active status, or subjectDN. Returns the full updated credential including: id, username, clientKey, description, roles, active. Required: id, merchant_id, apiCredentialId.

create_a_adyen_merchant_payment_method_setting

Request a new payment method for an Adyen merchant account. Returns the created payment method including id, type, enabled, allowed, countries, currencies, and verificationStatus. Required: merchant_id, type.

get_single_adyen_merchant_payment_method_setting_by_id

Get payment method details for an Adyen merchant account by id. Returns: accel, affirm, afterpayTouch, alipayPlus, allowed, amex, ancv, applePay, associatedPaymentMethods, bcmc, businessLineId, carnet, cartesBancaires, clearpay, countries, cup, currencies, enabled, id, type, and 2 more fields. Required: id, merchant_id, paymentMethodId.

adyen_merchant_payment_method_settings_get_apple_pay_domains

Get all Apple Pay domains registered with an Adyen merchant account and payment method. Returns: domains. Required: merchant_id, payment_method_id.

list_all_adyen_merchant_payment_method_settings

List all payment methods configured for an Adyen merchant account. Returns: accel, affirm, afterpayTouch, alipayPlus, allowed, amex, ancv, applePay, associatedPaymentMethods, bcmc, businessLineId, carnet, cartesBancaires, clearpay, countries, cup, currencies, customRoutingFlags, diners, enabled, id, type, 40 more. Required: merchant_id.

update_a_adyen_merchant_payment_method_setting_by_id

Update payment method details for an Adyen merchant account by id. Returns the updated payment method including id, type, enabled, allowed, countries, and verificationStatus. Required: id, merchant_id, paymentMethodId.

create_a_adyen_merchant_payout_setting

Add a payout setting that links an Adyen merchant account to the transfer instrument holding its payout bank account details. Returns: allowed, enabled, enabledFromDate, id, priority, transferInstrumentId, verificationStatus. Required: merchant_id, transferInstrumentId.

delete_a_adyen_merchant_payout_setting_by_id

Delete a payout setting for a merchant account in Adyen. Returns an empty 204 response on success. Required: id, merchant_id, payoutSettingsId.

get_single_adyen_merchant_payout_setting_by_id

Get a single payout setting for an Adyen merchant account by id. Returns: allowed, enabled, enabledFromDate, id, priority, transferInstrumentId, verificationStatus. Required: id, merchant_id, payoutSettingsId.

list_all_adyen_merchant_payout_settings

List the payout settings configured for an Adyen merchant account. Returns: allowed, enabled, enabledFromDate, id, priority, transferInstrumentId, verificationStatus. Required: merchant_id.

update_a_adyen_merchant_payout_setting_by_id

Update a payout setting for an Adyen merchant account to enable or disable it. Returns: allowed, enabled, enabledFromDate, id, priority, transferInstrumentId, verificationStatus. Required: id, merchant_id, payoutSettingsId.

create_a_adyen_merchant_shipping_location

Create a shipping location for an Adyen merchant account. Returns the created location with its id, name, address, and contact details. Required: merchant_id.

list_all_adyen_merchant_shipping_locations

List shipping locations for an Adyen merchant account. Each location includes its id, name, address, and contact details. Required: merchant_id.

list_all_adyen_merchant_billing_entities

List the billing entities of an Adyen merchant account — legal entities that orders are charged to. Returns: address, email, id, name, taxId. Required: merchant_id.

create_a_adyen_merchant_store

Create a new store for a merchant account in Adyen. Returns the created store with id, reference, status, address, and description. Required: merchant_id, address, description, phoneNumber, shopperStatement.

get_single_adyen_merchant_store_by_id

Get a single Adyen store by id for a merchant account. Returns the store details including id, reference, status, address, and merchantId. Required: id, merchant_id, storeId.

list_all_adyen_merchant_stores

List Adyen stores for a merchant account, grouped into pages. Returns each store's id, reference, status, address, and description. Max 100 per page. Required: merchant_id.

update_a_adyen_merchant_store_by_id

Update a store in Adyen; only some store parameters can be updated. Returns the updated store with id, reference, status, address, and merchantId. Required: id, merchant_id, storeId.

create_a_adyen_merchant_split_configuration

Create a split configuration profile for an Adyen merchant account to split payments automatically across associated stores. Returns: description, rules, splitConfigurationId. Required: merchant_id, merchant_id, description, rules.

delete_a_adyen_merchant_split_configuration_by_id

Delete a split configuration profile by id from an Adyen merchant account. Returns an empty 204 response on success. Required: id, merchant_id, splitConfigurationId.

get_single_adyen_merchant_split_configuration_by_id

Get the details of a split configuration profile by id for an Adyen merchant account. Returns: description, rules, splitConfigurationId. Required: id, merchant_id, merchant_id, splitConfigurationId.

list_all_adyen_merchant_split_configurations

List the split configuration profiles of an Adyen merchant account. Returns: description, rules, splitConfigurationId. Required: merchant_id, merchant_id.

adyen_merchant_split_configurations_partial_update

Update the description of a split configuration profile in an Adyen merchant account. Returns: description, rules, split_configuration_id. Required: merchant_id, split_configuration_id, description.

update_a_adyen_merchant_split_configuration_by_id

Create a rule on a merchant split configuration in Adyen. Returns the split configuration including its description, rules, and splitConfigurationId. Required: id, merchant_id, merchant_id, splitConfigurationId, currency, fundingSource, paymentMethod, shopperInteraction, splitLogic.

delete_a_adyen_rule_by_id

Delete a rule from an Adyen split configuration. Returns an empty 204 response on success. Required: id, merchant_id, split_configuration_id, ruleId.

update_a_adyen_rule_by_id

Update the split conditions of a rule in an Adyen split configuration. Returns the updated split configuration: description, rules, splitConfigurationId. Required: id, merchant_id, split_configuration_id, ruleId, currency, fundingSource, paymentMethod, shopperInteraction.

update_a_adyen_rule_split_logic_by_id

Update the split logic of a rule within an Adyen split configuration. Returns the updated split configuration with description, rules, and split_configuration_id. Required: id, merchant_id, split_configuration_id, rule_id, merchant_id, split_configuration_id, rule_id, splitLogicId, commission.

list_all_adyen_store_terminal_logos

Get the terminal logo configured for a specific payment terminal model at an Adyen store; it applies to all terminals of that model under the store unless a different logo is set for an individual terminal. Returns: data. Required: store_id, model, store_id.

adyen_store_terminal_logos_bulk_update

Update the terminal logo for a specific payment terminal model at an Adyen store. Returns: data. Pass an empty logo value in data to restore the logo inherited from the merchant or company account. Required: store_id, model.

update_a_adyen_store_terminal_logo_by_id

Update the terminal logo for a payment terminal model at an Adyen store identified by merchant and store reference; pass an empty logo value in data to restore the logo inherited from the merchant or company account. Only one terminal model per request. Returns: data. Required: merchant_id, reference, model, storeId.

create_a_adyen_webhook_generate_hmac

Generate a new HMAC key for a webhook configuration of a company account in Adyen. Returns: hmacKey. Creating an HMAC key makes Adyen send HMAC-signed notifications for this webhook. Required: company_id, webhook_id, company_id, webhook_id.

create_a_adyen_webhook_generate_hmacs_generatehmac

Generate a new HMAC key for a webhook of a merchant account in Adyen. Returns: hmacKey. Required: merchant_id, webhook_id. Adyen signs notifications with the new key; keep accepting the previous key while it propagates.

create_a_adyen_webhook_test

Test an Adyen webhook configuration by sending sample notifications to verify it is set up correctly. Returns: merchantId, output, requestSent, and 3 more fields. Required: company_id, webhook_id. Sample notifications cover up to 20 merchant accounts; use merchantIds to select a subset when the webhook is configured for more.

create_a_adyen_webhook_tests_test

Send a test notification for an Adyen webhook to verify its configuration. Returns: merchant_id, output, requestSent, responseCode, responseTime, status. Required: merchant_id, webhook_id.

create_a_adyen_add_apple_pay_domain

Add an Apple Pay domain to the list of domains registered with an Adyen merchant account and payment method. Returns an empty 204 response on success. Required: merchant_id, payment_method_id, domains.

get_single_adyen_campaign_management_account_holder_by_id

List the donation campaigns for an Adyen account holder. Returns each campaign's id and status. Filter by status: inactive, active, or ended. Required: id, company_id, accountHolderId.

create_a_adyen_companie_campaign_management

Create a donation campaign in Adyen so shoppers can donate to a nonprofit when paying online or in person. Returns: accountHolderIds, activatedAt, endedAt, id, inPerson, name, nonprofitCause, online, status. Required: company_id, name, nonprofitCauseId.

delete_a_adyen_companie_campaign_management_by_id

Delete a donation campaign in Adyen by id. Only campaigns with the status inactive can be removed. Returns an empty 204 response on success. Required: id, company_id, donationCampaignId.

update_a_adyen_companie_campaign_management_by_id

Update a donation campaign in Adyen by id. Returns: accountHolderIds, activatedAt, endedAt, id, inPerson, name, nonprofitCause, online, status. PATCH cannot change campaign status; activate or end campaigns via the status endpoint. Required: id, company_id, donationCampaignId.

create_a_adyen_companie_client_certificate

Generate an Adyen client certificate for mTLS by submitting a certificate signing request (CSR) for a company account. Returns: caChain, id, leaf, serialNumber, subjectDN. Required: company_id, apiCredential, certificateSigningRequest. Requires company_id, apiCredential, and certificateSigningRequest.

list_all_adyen_companie_client_certificates

List all valid client certificates (neither expired nor revoked) under an Adyen company account. Returns: caChain, id, leaf, serialNumber, subjectDN. Required: company_id.

create_a_adyen_companie_nonprofit

List Adyen-supported nonprofit organizations to choose from when creating a donation campaign, filtered to those compatible with all specified account holders. Returns: _links, itemsTotal, nonprofits, pagesTotal. searchTerm max 100 characters. Required: company_id, accountHolderIds.

create_a_adyen_companie_terminal_theme

Create a basic Adyen terminal theme (a name plus dark or light mode) for a company account to customize Android payment terminal screens. Returns: id, mode, name. Theme names must be unique within the company account. Required: company_id, mode, name.

delete_a_adyen_companie_terminal_theme_by_id

Delete a terminal theme in Adyen by id. Returns an empty 204 response on success. A theme that is currently in use must first be deactivated via the unapply endpoint before it can be deleted. Required: id, company_id, company_id.

get_single_adyen_companie_terminal_theme_by_id

Get a single Adyen terminal theme by id. Returns: assets, id, mode, name. Required: id, company_id.

list_all_adyen_companie_terminal_themes

List Adyen terminal themes for a company account and its associated merchant accounts. Returns theme metadata only: id, name, mode. Assets are not included in list responses. Required: company_id.

update_a_adyen_companie_terminal_theme_by_id

Update the metadata (name and dark or light mode) of an Adyen terminal theme by id. Returns: id, mode, name. Required: id, company_id.

adyen_merchant_terminal_logos_bulk_update

Update the terminal logo configured for a specific payment terminal model under an Adyen merchant account. Returns: data. Required: merchant_id, model.

list_all_adyen_merchant_terminal_logos

Get the terminal logo configured for a specific payment terminal model under an Adyen merchant account. Returns: data. The logo applies to all terminals of that model unless overridden at store or terminal level. Required: merchant_id, model.

list_all_adyen_merchant_terminal_models

List the payment terminal models that an Adyen merchant account has access to. Returns the terminal models including their terminal model id (for example, Verifone.M400), which can be used when listing terminals or ordering terminal products. Required: merchant_id.

adyen_merchant_terminal_orders_cancel

Cancel a terminal products order in Adyen. Returns: billingEntity, customerOrderReference, id, items, orderDate, shippingLocation, status, trackingUrl. Only orders with status Placed can be cancelled, and the call takes no request body. Required: merchant_id, order_id.

create_a_adyen_merchant_terminal_order

Create a new order for payment terminal products in Adyen for the given merchant account. Returns the created order with id, status, items, orderDate, and trackingUrl. Test-environment requests do not create real orders for test terminals. Required: merchant_id.

get_single_adyen_merchant_terminal_order_by_id

Get the details of a single terminal products order in Adyen by id. Returns the order with id, status, items, orderDate, and trackingUrl. Required: id, merchant_id, orderId.

list_all_adyen_merchant_terminal_orders

List the terminal products orders of an Adyen merchant account. Returns orders with id, status, items, orderDate, and trackingUrl. Required: merchant_id.

update_a_adyen_merchant_terminal_order_by_id

Update a terminal products order in Adyen by id. Only possible while the order status is Placed; changes to the items array must include the entire array. Returns the updated order with id, status, items, orderDate, and trackingUrl. Required: id, merchant_id, orderId.

list_all_adyen_merchant_terminal_products

List the payment terminal packages and parts an Adyen merchant account has access to, filtered by country. Returns: description, id, itemsIncluded, name, price. Required: merchant_id, country.

adyen_merchant_terminal_settings_bulk_update

Update the Adyen payment terminal settings configured for a merchant account. Returns the updated settings, including cardholderReceipt, connectivity, payment, receiptPrinting, and surcharge. Settings apply to all terminals under the merchant unless overridden at store or terminal level. Required: merchant_id.

list_all_adyen_merchant_terminal_settings

Get the Adyen payment terminal settings for a merchant account. Returns the configured settings, including cardholderReceipt, connectivity, payment, receiptPrinting, and wifiProfiles. Settings apply to all terminals under the merchant unless overridden at store or terminal level. Required: merchant_id.

create_a_adyen_merchant_user

Create a new user for an Adyen merchant. Returns the created user's id, username, email, name, roles, timeZoneCode, and active flag. Required: merchant_id, email, name, username.

get_single_adyen_merchant_user_by_id

Get details of a single user on an Adyen merchant. Returns the user's id, username, email, name, roles, timeZoneCode, and active flag. Required: id, merchant_id, userId.

list_all_adyen_merchant_users

List users associated with an Adyen merchant, optionally filtered by partial or complete username. Returns each user's id, username, email, name, roles, and timeZoneCode. Max 100 users per page. Required: merchant_id.

update_a_adyen_merchant_user_by_id

Update an existing user on an Adyen merchant, such as name, email, roles, account groups, or active status. Returns the updated user's id, username, email, name, roles, timeZoneCode, and active flag. Required: id, merchant_id, userId.

delete_a_adyen_merchant_webhook_by_id

Delete a merchant webhook configuration in Adyen, removing the configuration for the webhook identified by id under the given merchant account. Returns an empty 204 response on success. Required: id, merchant_id, webhookId.

get_single_adyen_merchant_webhook_by_id

Get the configuration of a specific webhook for a merchant in Adyen. Returns the full webhook object including id, url, active, communicationFormat, and type. Required: id, merchant_id, webhookId.

update_a_adyen_merchant_webhook_by_id

Update the configuration of a webhook for a merchant in Adyen with new values for fields like url, active, username, and password. Returns the full updated webhook object including id, url, active, communicationFormat, and type. Required: id, merchant_id, webhookId.

create_a_adyen_status

Activate or end an Adyen donation campaign. Returns the updated campaign record with id and status. Only the transitions activate (start an inactive campaign) and end (stop an active campaign) are allowed. Required: company_id, donation_campaign_id, status.

list_all_adyen_store_terminal_logos_terminallogos

Get the terminal logo configured for a specific Adyen store under a merchant account. Returns: data. Required: merchant_id, reference, model.

adyen_store_terminal_settings_bulk_update

Update payment terminal settings for an Adyen store by store id. Returns the updated settings including payment, connectivity, receiptPrinting, and wifiProfiles objects. Required: store_id.

update_a_adyen_store_terminal_setting_by_id

Update payment terminal settings for an Adyen merchant's store by reference; include the full settings object for any parameter you change. Returns the updated settings including payment, connectivity, receiptPrinting, and wifiProfiles objects. Required: merchant_id, reference, storeId.

list_all_adyen_store_terminal_settings

Get the payment terminal settings configured for an Adyen store, applying to all terminals under it unless overridden per terminal. Returns terminal settings including payment, connectivity, receiptPrinting, and wifiProfiles objects. Required: store_id.

list_all_adyen_store_terminal_settings_terminalsettings

Get the payment terminal settings configured for a specific Adyen store; they apply to all terminals under the store unless overridden per terminal. Returns: cardholderReceipt, connectivity, dcc, gratuities, hardware, homeScreen, kioskMode, receiptOptions, standalone, surcharge, wifiProfiles, and 16 more. Required: merchant_id, reference.

create_a_adyen_store

Create a store for a merchant account in Adyen. Returns the created store including id, merchantId, reference, status, and address. Requires address, description, merchantId, phoneNumber, and shopperStatement. Required: address, description, merchantId, phoneNumber, shopperStatement.

get_single_adyen_store_by_id

Get the details of a single Adyen store by id. Returns: _links, address, businessLineIds, description, externalReferenceId, id, localizedInformation, merchantId, phoneNumber, reference, shopperStatement, splitConfiguration, status, subMerchantData. Required: id.

list_all_adyen_stores

List Adyen stores. Returns each store with id, merchantId, reference, status, and address. Max 100 per page.

update_a_adyen_store_by_id

Update select parameters of an Adyen store by id. Returns the updated store including id, merchantId, reference, status, and address. Required: id. Only some store parameters can be updated.

create_a_adyen_terminal_reassign

Reassign an Adyen payment terminal (terminal_reassigns) to a company account, merchant account, merchant account inventory, or store. Returns an empty response body on success (HTTP 200, no content). Required: terminal_id.

adyen_terminal_terminal_logos_bulk_update

Update the logo of an Adyen payment terminal. Returns the updated logo as a Base64-encoded string in data. Required: terminal_id.

list_all_adyen_terminal_terminal_logos

Get the logo configured for an Adyen payment terminal. Returns the logo as a Base64-encoded string in data, which must be Base64-decoded to obtain the actual image file. Required: terminal_id.

adyen_terminal_terminal_settings_bulk_update

Update the terminal settings of a specific Adyen payment terminal. Returns the updated settings including cardholderReceipt, connectivity, payment, receiptPrinting, and wifiProfiles. Required: terminal_id.

list_all_adyen_terminal_terminal_settings

Get the terminal settings configured for a specific Adyen payment terminal. Returns: cardholderReceipt, connectivity, dcc, gratuities, hardware, homeScreen, kioskMode, localization, moto, nexo, offlineProcessing, opi, payment, refunds, signature, standalone, surcharge, tapToPay, wifiProfiles, and 8 more. Required: terminal_id, terminal_id.

list_all_adyen_terminals

List the payment terminals the API credential can access, filterable by country, merchant account, store, or brand model. Returns: assignment, connectivity, firmwareVersion, id, lastActivityAt, lastTransactionAt, model, serialNumber, and 4 more. pageSize capped at 100 (default 20); searchQuery or otpQuery ignore other filters.

adyen_terminals_search

Get the company account, merchant account, or store that a payment terminal is assigned to. Returns: companyAccount, merchantAccount, merchantInventory, store, terminal. Required: terminal. Deprecated — support stops April 1, 2025; use the Management API instead.

create_a_adyen_terminals_schedule_action

Schedule a terminal action in Adyen for a set of payment terminals. Returns: actionDetails, items, scheduledAt, storeId, terminalsWithErrors, totalErrors, totalScheduled. Required: actionDetails, terminalIds. Max 100 terminals per request, and only one action can be scheduled at a time.

create_a_adyen_apply

Apply a terminal theme in Adyen to all Android terminals under a company account; terminals with a theme applied at a lower level keep that override. Only company-owned themes can be applied at company level. Returns an empty 200 OK response on success. Required: company_id, terminal_theme_id, company_id, id.

create_a_adyen_applies_apply

Apply a terminal theme to all Android terminals under a merchant account in Adyen; a theme applied at a lower level (store or individual terminal) takes precedence. Returns an empty response on success. Required: merchant_id, terminal_theme_id.

adyen_assets_bulk_delete

Delete an asset from a terminal theme of a company account in Adyen, identified by its screen type and terminal model. Returns an empty 204 response on success. Required: company_id, terminal_theme_id, type, model. Logo assets cannot be deleted when the theme owner is not allowed to edit logos.

adyen_assets_bulk_delete_merchants

Delete an asset (such as a logo or screen background) from a terminal theme owned by a merchant account in Adyen, identified by type and model. Returns an empty 204 response on success. Required: merchant_id, terminal_theme_id, type, model. Logo assets are only supported with model=All, and deleting a logo asset is blocked if the theme owner is…

create_a_adyen_asset

Add an image or video asset to an Adyen terminal theme. Returns: model, type, url, BasicAuth. Required: company_id, terminal_theme_id in the path; type, model as query parameters; file in the multipart body. Fails if the theme already has an asset for the same type and model — use the replace endpoint instead.

create_a_adyen_assets_replace

Replace an existing image or video asset of an Adyen terminal theme. Returns: model, type, url, BasicAuth. The theme must already have an asset for that type/model pair; max size 10 MB (100 MB for SFO1/M450). Required: company_id, terminal_theme_id, and query parameters type and model; the request body is a single multipart file part named file.

create_a_adyen_assets_replaces_replace

Replace an asset of a terminal theme in Adyen by uploading a new file. Returns: model, type, url. Required: merchant_id, terminal_theme_id, type, model, and file.

create_a_adyen_assets_terminaltheme

Add an image or video asset to an Adyen merchant-level terminal theme via multipart upload. The required merchant_id, terminal_theme_id, type, and model query parameters select the merchant, theme, screen type, and terminal model. Returns: model, type, url. Required: file.

create_a_adyen_business_line

Create a business line for a legal entity in Adyen, capturing industry, service, sales channels, and source of funds for verification. Returns: id, industryCode, industryCodeDescription, and 5 more fields. Required: industryCode, legalEntityId, service. Requires industryCode, legalEntityId, and service. Max 200 business lines per legal entity.

delete_a_adyen_business_line_by_id

Delete an Adyen business line by id. Returns an empty 204 response on success. Required: id. Deleting a business line linked to a payment method removes it from all linked merchant accounts and may affect payment method usage.

get_single_adyen_business_line_by_id

Get a single Adyen business line by id. Returns the full business line including id, legalEntityId, service, industryCode, salesChannels, and sourceOfFunds. Required: id.

list_all_adyen_business_lines

List all business lines owned by a legal entity in Adyen. Returns: businessLines. Required: legal_entity_id, id.

update_a_adyen_business_line_by_id

Update an Adyen business line by id, adjusting its industry code, sales channels, source of funds, or web data. Returns: id, industryCode, industryCodeDescription, legalEntityId, problems, salesChannels, service, sourceOfFunds, webData, webDataExemption. Required: id.

create_a_adyen_document

Upload a document for verification checks in Adyen. Returns: attachment, attachments, creationDate, description, expiryDate, fileName, id, issuerCountry, issuerState, modificationDate, number, owner, type. Required: description, type. Photo IDs are limited to a maximum of 15 pages.

delete_a_adyen_document_by_id

Delete an Adyen document by id. Returns an empty 204 response on success. Required: id.

get_single_adyen_document_by_id

Get a single Adyen document by id. Returns: attachment, attachments, creationDate, description, expiryDate, fileName, id, issuerCountry, issuerState, modificationDate, number, owner, type. Required: id.

update_a_adyen_document_by_id

Update an Adyen document by id. Returns: attachment, attachments, creationDate, description, expiryDate, fileName, id, issuerCountry, issuerState, modificationDate, number, owner, type. Required: id. Photo IDs are limited to a maximum of 15 pages.

create_a_adyen_merchant_terminal_theme

Create a terminal theme for an Adyen merchant account to customize screens on Android payment terminals. Returns: id, mode, name. Creates only the basic theme metadata; the name must be unique within the merchant account. Required: merchant_id, mode, name.

delete_a_adyen_merchant_terminal_theme_by_id

Delete a terminal theme in Adyen by id. Returns an empty 204 response on success. A theme that is currently in use must first be deactivated via the unapply endpoint before it can be deleted. Required: id, merchant_id, merchant_id.

get_single_adyen_merchant_terminal_theme_by_id

Get a terminal theme by id, including the CDN URLs of all assets added to it. Returns: assets, id, mode, name. Required: id, merchant_id.

list_all_adyen_merchant_terminal_themes

List terminal themes for an Adyen merchant account. Returns theme metadata only: id, name, mode; assets are not included. Supports case-insensitive filtering by name via search. Required: merchant_id.

update_a_adyen_merchant_terminal_theme_by_id

Update the metadata (name and dark or light mode) of a terminal theme by id. Returns: id, mode, name. The theme name must be unique within the merchant account. Required: id, merchant_id.

create_a_adyen_terminal_themes_unapply

Unapply the terminal theme for an Adyen company account, resetting its terminals to the default Adyen theme; terminals with a theme applied at merchant, store, or terminal level keep theirs. Returns: status. Succeeds even when no theme is applied. Required: company_id, company_id.

create_a_adyen_terminal_themes_unapplies_unapply

Unapply a terminal theme from an Adyen merchant account, resetting its Android terminals to the company-level custom theme or the default Adyen theme; the theme itself is not deleted. Returns: status. Required: merchant_id.

list_all_adyen_accepted_terms_of_service_documents

Get the accepted Terms of Service document for a legal entity in Adyen. Returns: document, id, termsOfServiceAcceptanceReference, termsOfServiceDocumentFormat. Required: legal_entity_id, termsofserviceacceptancereference, id.

create_a_adyen_account_holder

Create an account holder in the Adyen Balance Platform linked to a legal entity. Returns the created account holder with id, legalEntityId, status, balancePlatform, and capabilities. Required: legalEntityId.

get_single_adyen_account_holder_by_id

Get a single account holder from the Adyen Balance Platform by id. Returns: balancePlatform, capabilities, contactDetails, description, id, legalEntityId, metadata, migratedAccountHolderCode, primaryBalanceAccount, reference, status, timeZone, verificationDeadlines. Required: id.

list_all_adyen_account_holders

List all account holders under an Adyen Balance Platform. Returns: accountHolders, hasNext, hasPrevious. Max 100 per page. Required: balance_platform_id, id.

update_a_adyen_account_holder_by_id

Update an account holder in the Adyen Balance Platform by id; fields not provided are left unchanged. Returns: balancePlatform, capabilities, contactDetails, description, id, legalEntityId, metadata, migratedAccountHolderCode, primaryBalanceAccount, reference, status, timeZone, verificationDeadlines. Required: id.

create_a_adyen_check_tax_electronic_delivery_consent

Check a legal entity's consent status for electronic delivery of tax forms in Adyen. Returns the consent status payload in the `attributes` object. Required: legal_entity_id, id.

create_a_adyen_check_verification_error

Check a legal entity's verification errors in Adyen, including errors for its supporting entities. Returns: problems. Required: legal_entity_id, id.

create_a_adyen_confirm_data_review

Confirm data review for a legal entity in Adyen, informing Adyen that your user reviewed and verified the entity's data is up-to-date. Returns: dataReviewedAt. Required: legal_entity_id, id.

create_a_adyen_legal_entity

Create a legal entity in Adyen to onboard a user or organization in your platform for verification checks. Returns: capabilities, documentDetails, documents, entityAssociations, id, individual, organization, problems, reference, type, verificationPlan, and 5 more. Required: type.

get_single_adyen_legal_entity_by_id

Get a legal entity in Adyen by id. Returns the full legal entity including id, type, individual or organization details, capabilities, entityAssociations, problems, and verificationPlan. Required: id.

update_a_adyen_legal_entity_by_id

Update a legal entity in Adyen by id. Returns the updated legal entity with id, type, individual or organization details, capabilities, problems, and verificationPlan. Required: id. To change the entity type, include only the new type; entityAssociations updates replace the entire array.

create_a_adyen_onboarding_link

Create an onboarding link for a legal entity in Adyen. Returns: url. Required: legal_entity_id, id.

list_all_adyen_pci_questionnaires

Get a list of signed PCI questionnaires for an Adyen legal entity. Returns: createdAt, id, validUntil. Required: legal_entity_id, id.

create_a_adyen_pci_questionnaires_generate_pci_template

Generate the required PCI questionnaires for an Adyen legal entity based on its sales channels. Returns: content, language, pciTemplateReferences. Required: legal_entity_id, id.

list_all_adyen_pci_questionnaires_pciquestionnaires

Get a PCI questionnaire for a legal entity in Adyen. Returns: content, createdAt, id, validUntil. Required: legal_entity_id, pciid.

create_a_adyen_pci_questionnaires_sign_pci_template

Sign the required PCI questionnaire for a legal entity in Adyen. Returns: pciQuestionnaireIds, signedBy. Required: legal_entity_id, id, pciTemplateReferences, signedBy.

create_a_adyen_pci_questionnaires_signing_required

Calculate the PCI status of an Adyen legal entity to determine whether a PCI questionnaire must be signed. Returns: signingRequired. Required: legal_entity_id, id.

create_a_adyen_request_periodic_review

Request a periodic data review for a legal entity in Adyen. Returns an empty 204 response on success. Required: legal_entity_id and id.

create_a_adyen_set_tax_electronic_delivery_consent

Set the consent status for electronic delivery of tax forms for a legal entity in Adyen. Returns an empty 200 response on success (no response body). Requires legal_entity_id and a JSON request body. Required: legal_entity_id, id.

list_all_adyen_terms_of_service_acceptance_infos

Get Terms of Service acceptance information for a legal entity in Adyen. Returns: acceptedBy, acceptedFor, createdAt, id, type, validTo. Required: legal_entity_id, id.

get_single_adyen_terms_of_service_status_by_id

Get the required Terms of Service types that an Adyen legal entity must accept. Returns: termsOfServiceTypes. Required: id.

adyen_terms_of_services_bulk_update

Accept Terms of Service for an Adyen legal entity by updating the stored document record. Returns: acceptedBy, id, ipAddress, language, termsOfServiceDocumentId, type. Required: legal_entity_id, termsofservicedocumentid, acceptedBy.

create_a_adyen_terms_of_service

Get the Terms of Service document for an Adyen legal entity. Returns: document, id, language, termsOfServiceDocumentFormat, termsOfServiceDocumentId, type. Required: legal_entity_id, id, language, type.

get_single_adyen_theme_by_id

Get an Adyen hosted onboarding page theme by id. Returns the theme's id, description, properties, createdAt, and updatedAt. Required: id.

list_all_adyen_themes

List Adyen hosted onboarding page themes. Returns: next, previous, themes.

create_a_adyen_transfer_instrument

Create a transfer instrument (a bank account owned by a legal entity) in Adyen. Returns the created instrument including id, legalEntityId, bankAccount, type, capabilities, and problems. Requires bankAccount, legalEntityId, and type. Required: bankAccount, legalEntityId, type.

delete_a_adyen_transfer_instrument_by_id

Delete an Adyen transfer instrument by id. Returns an empty 204 response on success. Required: id.

get_single_adyen_transfer_instrument_by_id

Get the details of a transfer instrument in Adyen by id. Returns: bankAccount, capabilities, documentDetails, id, legalEntityId, problems, type. Required: id.

update_a_adyen_transfer_instrument_by_id

Update a transfer instrument in Adyen by id. Returns the updated instrument including id, legalEntityId, bankAccount, type, capabilities, and documentDetails. Required: id.

get_single_adyen_balance_platform_by_id

Get a single balance platform in Adyen by its unique identifier. Returns: description, id, status. Required: id.

get_single_adyen_grant_account_by_id

Get the details of a specific grant account in Adyen Capital by id. Returns: balances, fundingBalanceAccountId, id, limits. Required: id.

get_single_adyen_grant_accounts_grantaccount_by_id

Get a grant account in Adyen Capital by id. Returns: balances, fundingBalanceAccountId, id, limits. Required: id.

create_a_adyen_grant_offer

Create a static Adyen Capital grant offer for the financing amount the user selected from a dynamic offer. Returns: accountHolderId, amount, contractType, expiresAt, fee, id, repayment, startsAt. Required: dynamic_offer_id, id, amount.

get_single_adyen_grant_offer_by_id

Get a single Adyen Capital grant offer by id. Returns: accountHolderId, amount, contractType, expiresAt, fee, id, repayment, startsAt. Required: id.

list_all_adyen_grant_offers

List all Adyen Capital grant offers available for a grant account. Returns grantOffers, an array of offers with id, amount, fee, and repayment details. Required: accountHolderId. Deprecated: use the Capital API /grantOffers endpoint instead.

get_single_adyen_grant_offers_grantoffer_by_id

Get a single grant offer by id from Adyen Capital. Returns: accountHolderId, amount, contractType, expiresAt, fee, id, repayment, startsAt. Required: id.

list_all_adyen_grant_offers_grantoffers

List all available grant offers from Adyen Capital for an account holder. Returns: grantOffers. Required: accountHolderId. Deprecated: use the /grantOffers endpoint from the Capital API instead.

create_a_adyen_balance_account

Create a balance account in Adyen that holds the funds of an account holder. Returns the created account including id, accountHolderId, status, balances, defaultCurrencyCode, and reference. Required: accountHolderId.

get_single_adyen_balance_account_by_id

Get a single Adyen balance account by id, including its balances for the default currency and other currencies with a non-zero balance. Returns: accountHolderId, balances, defaultCurrencyCode, description, id, metadata, migratedAccountCode, platformPaymentConfiguration, reference, status, timeZone. Required: id.

list_all_adyen_balance_accounts

List all balance accounts of an Adyen account holder, paginated. Returns: balanceAccounts, hasNext, hasPrevious. Max 100 per page. Required: account_holder_id, id.

update_a_adyen_balance_account_by_id

Update an Adyen balance account by id. Returns the updated account including id, accountHolderId, status, balances, defaultCurrencyCode, and reference. Required: id.

create_a_adyen_payment_instrument

Create a payment instrument in Adyen to issue a physical card, a virtual card, or a business account. Returns: additionalBankAccountIdentifications, balanceAccountId, bankAccount, card, description, id, issuingCountryCode, paymentInstrumentGroupId, reference, status, type, and 4 more. Required: balanceAccountId, issuingCountryCode, type.

get_single_adyen_payment_instrument_by_id

Get the details of a payment instrument in Adyen by id. Returns: additionalBankAccountIdentifications, balanceAccountId, bankAccount, card, description, id, issuingCountryCode, paymentInstrumentGroupId, reference, replacedById, replacementOfId, status, statusComment, statusReason, type. Required: id.

list_all_adyen_payment_instruments

List payment instruments linked to a balance account in Adyen. Returns: hasNext, hasPrevious, paymentInstruments. Max 100 per page. Required: balance_account_id, id.

update_a_adyen_payment_instrument_by_id

Update a payment instrument in Adyen by id. Returns: additionalBankAccountIdentifications, balanceAccountId, bankAccount, card, description, id, issuingCountryCode, paymentInstrumentGroupId, reference, replacedById, replacementOfId, status, type, and 2 more. Required: id. Once a payment instrument is active, only its status can be updated.

create_a_adyen_association

Initiate an association between a registered SCA device and an Adyen resource, such as a business account or an Adyen-issued card. Returns: sdkInput. Required: device_id, ids, type.

adyen_associations_bulk_update

Complete an association between a registered SCA device and an Adyen resource by submitting the strong customer authentication results. Returns: device_id, ids, type. Required: device_id, ids, strongCustomerAuthentication, type.

create_a_adyen_registered_device

Initiate the registration of a user's SCA device in Adyen for strong customer authentication. Returns: id, paymentInstrumentId, sdkInput, success. Requires paymentInstrumentId and strongCustomerAuthentication. The device must be eligible for SCA. Required: paymentInstrumentId, strongCustomerAuthentication.

delete_a_adyen_registered_device_by_id

Delete a registered SCA device from Adyen's list of registered devices of a specific payment instrument. Returns an empty 204 response on success. Required: id and paymentInstrumentId.

list_all_adyen_registered_devices

List the SCA devices currently registered for a specific payment instrument in Adyen. Returns: id, name, paymentInstrumentId, type. Required: paymentInstrumentId. Max 100 per page.

update_a_adyen_registered_device_by_id

Complete the registration of an SCA device in Adyen by validating the device's authentication data. Returns: success. Required: id.

create_a_adyen_transaction_rule

Create an Adyen transaction rule that allows or declines card transactions based on defined conditions. Returns: aggregationLevel, description, endDate, entityKey, id, and 8 more fields. Required: description, entityKey, interval, reference, ruleRestrictions, type. Requires description, entityKey, interval, reference, ruleRestrictions, and type.

delete_a_adyen_transaction_rule_by_id

Delete an Adyen transaction rule by id. Returns the deleted transaction rule including its id, description, status, and type. Required: id.

get_single_adyen_transaction_rule_by_id

Get an Adyen transaction rule by id. Returns the transactionRule object with its full details. Required: id.

list_all_adyen_transaction_rules

List transaction rules for an Adyen account holder. Returns transactionRules, each with id, description, status, and type. Required: account_holder_id, id.

update_a_adyen_transaction_rule_by_id

Update an Adyen transaction rule by id. Returns the updated rule with id, description, status, and type. Required: id. To change only the status, send status alone; other updates require sending all existing parameters.

list_all_adyen_transaction_rules_transactionrules

List all transaction rules configured for a balance account in Adyen. Returns each rule with id, reference, description, type, status, interval, ruleRestrictions, entityKey, and startDate. Required: balance_account_id.

list_all_adyen_cardorder_items

List the items of a specific Adyen card order. Returns card order items with id, cardOrderItemId, paymentInstrumentId, balancePlatform, card, pin, shippingMethod, and creationDate. Required: cardorder_id, id.

list_all_adyen_cardorders

List Adyen card orders with optional filters such as status, cardManufacturingProfileId, txVariantCode, createdSince, and createdUntil. Returns: cardOrders, hasNext, hasPrevious. Defaults to 10 per page.

create_a_adyen_network_token_activation_data

Create network token provisioning data for a payment instrument in Adyen so it can be added to a user's digital wallet. Returns the provisioning data including sdkInput. Required: payment_instrument_id, id.

get_single_adyen_network_token_activation_data_by_id

Get the network token activation data for a payment instrument in Adyen, used to add the instrument to digital wallets. Returns the activation data including sdkInput. Required: id.

get_single_adyen_network_token_by_id

Get a network token in Adyen by id. Returns the token object with the network token's id, status, paymentInstrumentId, creationDate, and tokenRequestor. Required: id.

list_all_adyen_network_tokens

List the network tokens connected to a payment instrument in Adyen. Returns each token's id, status, payment_instrument_id, brandVariant, and tokenRequestor details. Required: payment_instrument_id, id.

update_a_adyen_network_token_by_id

Update the status of an Adyen network token by id. The request is accepted for processing and returns an empty 202 response on success. Required: id.

create_a_adyen_payment_instrument_group

Create a payment instrument group in Adyen to associate and group payment instrument resources together, for example to apply a transaction rule to the group. Returns: balancePlatform, description, id, properties, reference, txVariant. The request body follows Adyen's PaymentInstrumentGroupInfo schema.

get_single_adyen_payment_instrument_group_by_id

Get a single Adyen payment instrument group by id. Returns: balancePlatform, description, id, properties, reference, txVariant. Required: id.

create_a_adyen_payment_instruments_reveal

Reveal an Adyen payment instrument's card data (PAN, CVC, and expiry date) as encrypted data that you can decrypt to show in your interface. Returns: encryptedData. Required: encryptedKey, paymentInstrumentId.

create_a_adyen_pins_change

Change the personal identification number (PIN) of a specified card in Adyen. Returns: status. Required: encryptedKey, encryptedPinBlock, paymentInstrumentId, token.

create_a_adyen_pins_reveal

Reveal the PIN of a specified Adyen card, returning an encrypted PIN block you can decrypt to display the PIN in your user interface. Returns: encryptedPinBlock, token. Required: encryptedKey, paymentInstrumentId.

list_all_adyen_public_keys

Get the Adyen RSA public key used to encrypt or decrypt card data, for example to generate the encryptedKey required to change a PIN, reveal a PIN, or reveal a PAN. Returns: publicKey, publicKeyExpiryDate.

get_single_adyen_reveal_by_id

Reveal the primary account number (PAN) of an Adyen payment instrument by id. Returns: cvc, expiration, pan. Required: id.

list_all_adyen_tax_forms

Get a tax form for an Adyen account holder operating in the US. Returns the generated form file: content (Base64), contentType. Required: account_holder_id, formType, year.

create_a_adyen_sweep

Create a sweep in Adyen that pulls in or pushes out funds for a balance account on a defined schedule, amount, and currency. Returns the created sweep with its id, type, status, currency, counterparty, and schedule. Required: balance_account_id, counterparty, currency, schedule.

delete_a_adyen_sweep_by_id

Delete a sweep from an Adyen balance account. Returns an empty 204 response on success. Required: id, balance_account_id, balance_account_id, sweepId.

get_single_adyen_sweep_by_id

Get a single Adyen sweep by id for a balance account. Returns the sweep with its id, type, status, currency, counterparty, and schedule. Required: id, balance_account_id, sweepId.

list_all_adyen_sweeps

List the sweeps configured for an Adyen balance account. Returns: hasNext, hasPrevious, sweeps. Max 100 items per page, 10 by default. Required: balance_account_id.

update_a_adyen_sweep_by_id

Update an Adyen sweep by id; parameters not provided in the request are left unchanged. Returns the updated sweep with its id, type, status, currency, counterparty, and schedule. Required: id, balance_account_id, sweepId.

adyen_authorised_card_users_bulk_delete

Delete all authorized users assigned to an Adyen card. Returns an empty 204 response on success. Required: payment_instrument_id.

adyen_authorised_card_users_bulk_update

Replace all authorized users of an Adyen card with the given list — the request overwrites every existing authorized user. Returns an empty 204 response on success. Maximum 10 legalEntityIds per request. Required: payment_instrument_id.

create_a_adyen_authorised_card_user

Assign authorized users to an Adyen card. Users must have the authorisedPaymentInstrumentUser capability to be able to use the card. Returns an empty 204 response on success. Required: payment_instrument_id, payment_instrument_id.

list_all_adyen_authorised_card_users

Get the authorized users for a card in Adyen. Returns the legal entity IDs (legalEntityIds) of every user authorized on the payment instrument. Required: payment_instrument_id.

adyen_bank_account_identifications_validate

Validate bank account identification details in Adyen before making a transfer or creating a transfer instrument. Returns an empty 200 response on success — the response code signals the validation result. Required: accountIdentification.

get_single_adyen_current_by_id

Get all current transfer limits that apply to an Adyen balance account by id. Returns transferLimits with each limit's id, amount (currency and value), scope, transferType, limitStatus, startsAt, endsAt, reference, and scaInformation. Required: id.

list_all_adyen_executions

List executions of a managed payout schedule on an Adyen balance account. Each execution is an attempt to make a payout according to the schedule. Returns: id, result, resultDetails, triggeredAt. Required: balance_account_id, payout_schedule_id, offset, id.

create_a_adyen_grant

Request the payout of a selected grant offer in Adyen Capital. Returns the grant including id, status, grantOfferId, grantAccountId, amount, and balances. Required: grantOfferId, grantAccountId.

get_single_adyen_grant_by_id

Get the details of an Adyen Capital grant by id. Returns: amount, balances, counterparty, fee, grantAccountId, grantOfferId, id, repayment, status. Required: id.

list_all_adyen_grants

List Adyen Capital grants with their status and outstanding balances. Returns a grants array whose items include id, status, grantOfferId, grantAccountId, amount, and balances.

adyen_mandates_cancel

Cancel a direct debit mandate in Adyen by its id. Returns an empty 202 Accepted response on success. Required: mandate_id.

get_single_adyen_mandate_by_id

Get the details of a specific direct debit mandate in Adyen. Returns: balanceAccountId, counterparty, createdAt, id, paymentInstrumentId, status, type, updatedAt. Required: id.

list_all_adyen_mandates

List all direct debit mandates created for a business account in Adyen. Returns the pagination link and the list of mandates, each with id, status (pending, approved, cancelled), type, counterparty bank details, paymentInstrumentId, balanceAccountId, and createdAt/updatedAt timestamps. Filterable by balanceAccountId and paymentInstrumentId.

update_a_adyen_mandate_by_id

Amend a direct debit mandate in Adyen by id. Returns an empty 202 Accepted response on success. Required: id.

create_a_adyen_payout_schedule

Apply a managed payout schedule to an Adyen balance account, based on an existing payout schedule in your balance platform. Returns: balance_account_id, createdAt, currency, enabled, frequency, id, transferInstrumentId, and 10 more. Required: balance_account_id, balance_account_id, balancePlatformPayoutScheduleId, transferInstrumentId.

delete_a_adyen_payout_schedule_by_id

Delete a payout schedule applied to a balance account in Adyen. Returns an empty 204 response on success. Required: id, balance_account_id.

get_single_adyen_payout_schedule_by_id

Get a managed payout schedule applied to an Adyen balance account by id. Returns: balance_account_id, balancePlatformPayoutScheduleId, createdAt, currency, description, enabled, frequency, frequencyValue, id, maxPayoutAmount, minPayoutAmount, reference, transferInstrumentId, and 4 more. Required: id, balance_account_id, balance_account_id.

list_all_adyen_payout_schedules

List all managed payout schedules configured on an Adyen balance account. Returns: balanceAccountPayoutSchedules, link. Max 100 items per page. Required: balance_account_id, balance_account_id.

update_a_adyen_payout_schedule_by_id

Update a managed payout schedule applied to an Adyen balance account by id; fields omitted from the request remain unchanged. Returns: balance_account_id, balancePlatformPayoutScheduleId, createdAt, currency, description, enabled, frequency, frequencyValue, id, retainedAmount, updatedAt, and 6 more. Required: id, balance_account_id, balance_account_id.

get_single_adyen_payout_schedules_payoutschedule_by_id

Get a specific managed payout schedule on your Adyen balance platform by id. Returns: automaticApplication, balance_platform_id, countryCode, createdAt, currency, defaultDescription, defaultFrequency, defaultFrequencyValue, defaultReference, defaultReferenceForBeneficiary, id, payoutScheduleDescription, and 8 more. Required: id, balance_platform_id.

list_all_adyen_payout_schedules_payoutschedules

List all managed payout schedules configured on your Adyen balance platform. Returns payout schedules with: id, balance_platform_id, payoutScheduleDescription, defaultFrequency, currency, countryCode. Required: balance_platform_id.

create_a_adyen_recurring_top_up

Create a recurring top up configuration for an Adyen balance account. Returns: counterparty, description, id, referenceForBeneficiary, status, topUpAmount, trigger. Required: balance_account_id, counterparty, description, topUpAmount, trigger.

delete_a_adyen_recurring_top_up_by_id

Delete a recurring top-up configuration in Adyen by id. Returns an empty 204 response on success. Required: id, balance_account_id, topUpId.

list_all_adyen_recurring_top_ups

List all recurring top ups configured for an Adyen balance account. Returns each top up with id, status, description, topUpAmount (fixed or target), trigger (schedule or threshold), and counterparty. Required: balance_account_id, balance_account_id. Max 100 per page.

update_a_adyen_recurring_top_up_by_id

Update the configuration of an existing recurring top up on an Adyen balance account. Returns: counterparty, description, id, referenceForBeneficiary, status, topUpAmount, trigger. Required: id, balance_account_id, topUpId.

adyen_sca_associations_bulk_delete

Delete one or more SCA associations between an entity and its Strong Customer Authentication devices in Adyen. Returns an empty 204 response on success. Required: entityType, entityId, scaDeviceIds.

adyen_sca_associations_bulk_update

Approve a pending approval SCA association in Adyen by updating its status. Returns scaAssociations with scaDeviceId, entityType, entityId, and status. Required: status, entityType, entityId, scaDeviceIds.

create_a_adyen_sca_association

Create a new SCA association between an Adyen SCA device and an entity such as an account holder; the association status may be pendingApproval until approved. Returns scaAssociations with scaDeviceId, entityType, entityId, and status. Required: device_id, device_id, entities.

list_all_adyen_sca_associations

List the Adyen SCA devices associated with a specific entity. Returns: createdAt, entityId, entityType, scaDeviceId, scaDeviceName, scaDeviceType, status. Max 10 per page. Required: entityType, entityId, pageSize, pageNumber.

create_a_adyen_sca_device

Begin SCA device registration in Adyen. Returns the created scaDevice with its id, name, and type, plus an sdkInput challenge for the SDK to process. Requires name and sdkOutput. Required: name, sdkOutput.

delete_a_adyen_sca_device_by_id

Delete a Strong Customer Authentication (SCA) device in Adyen by id. Returns an empty 204 response on success. Required: id.

update_a_adyen_sca_device_by_id

Finish SCA device registration in Adyen by submitting the SDK output for a device registered through the begin-registration call. Returns the completed scaDevice with its id, name, and type. Required: id (30-character device identifier), sdkOutput.

list_all_adyen_sweep_executions

List executions of a custom payout schedule (sweep) on a balance account in Adyen. Returns: id, result, resultDetails, triggeredAt. Required: balance_account_id, sweep_id.

get_single_adyen_tax_form_summary_by_id

Get a summary of tax forms for an account holder in Adyen. Returns per-legal-entity summaries with legalEntityId and taxYears. Required: id, formType.

create_a_adyen_transfer_limit

Create a transfer limit for an Adyen balance account. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. The new limit may start in pendingSCA status until SCA is completed. Required: balance_account_id, id, amount, scope, transferType.

delete_a_adyen_transfer_limit_by_id

Delete a scheduled or pending transfer limit for an Adyen balance account. Returns an empty 204 response on success. You cannot delete an active limit. Required: id, balance_account_id, transferLimitId.

get_single_adyen_transfer_limit_by_id

Get the details of a transfer limit on an Adyen balance account by id. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. Required: id, balance_account_id, transferLimitId.

list_all_adyen_transfer_limits

List the transfer limits configured for an Adyen balance account, filterable by scope, transferType, or status. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. Required: balance_account_id, id.

create_a_adyen_transfer_limits_approve

Approve pending transfer limits on an Adyen balance account — approves transfer limits that are pending SCA authentication. Returns an empty 204 response on success. Required: balance_account_id, id, transferLimitIds.

create_a_adyen_transfer_limits_transferlimit

Create a transfer limit for a balance platform in Adyen. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. Required: balance_platform_id, amount, scope, transferType.

delete_a_adyen_transfer_limits_transferlimit_by_id

Delete a scheduled or pending transfer limit in an Adyen balance platform. Returns an empty 204 response on success. Active limits cannot be deleted. Required: id, balance_platform_id.

get_single_adyen_transfer_limits_transferlimit_by_id

Get the details of a single transfer limit in an Adyen balance platform. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. Required: balance_platform_id, id.

list_all_adyen_transfer_limits_transferlimits

List and filter the transfer limits of an Adyen balance platform. Returns: amount, endsAt, id, limitStatus, reference, scaInformation, scope, startsAt, transferType. Required: balance_platform_id.

create_a_adyen_transfer_routes_calculate

Calculate available transfer routes in Adyen based on country, currency, counterparty, and priorities to find optimal transfer priorities and requirements before making a transfer. Returns: transferRoutes. Required: balancePlatform, category, currency.

create_a_adyen_webhook_setting

Create a balance webhook setting in Adyen defining the criteria (balance type, condition, value) that trigger balance webhooks. Returns: currency, id, status, target, type. Required: balance_platform_id, webhook_id, currency, status, target, type.

delete_a_adyen_webhook_setting_by_id

Delete an Adyen balance webhook setting by id, removing the conditions used to trigger balance webhooks. Returns an empty 204 response on success. Required: id, balance_platform_id, webhook_id, settingId.

get_single_adyen_webhook_setting_by_id

Get a single Adyen balance webhook setting by id. Returns: currency, id, status, target, type. Required: id, balance_platform_id, webhook_id, settingId.

list_all_adyen_webhook_settings

List all balance webhook settings configured for an Adyen balance webhook. Returns each setting's id, type, target, currency, status, and conditions. Required: balance_platform_id, webhook_id.

update_a_adyen_webhook_setting_by_id

Update an Adyen balance webhook setting by id, e.g. change its trigger conditions or activate/deactivate it. Returns: currency, id, status, target, type. Required: id, balance_platform_id, webhook_id, settingId.

list_all_adyen_account_holder

Get the details of an Adyen account holder. Returns: accountHolderCode, accountHolderDetails, accountHolderStatus, accounts, description, invalidFields, legalEntity, migrationData, primaryCurrency, pspReference, resultCode, systemUpToDateTime, verification, verificationProfile. May return 202 Accepted while processing is still in progress.

create_a_adyen_account_holder_balance

Get the balances of an account holder in Adyen, organized per currency per account. Returns: balancePerAccount, invalidFields, pspReference, resultCode, totalBalance. Requires accountHolderCode. Required: accountHolderCode.

create_a_adyen_account_holder_transaction_list

List transactions for an Adyen account holder's accounts, optionally filtered by account and transaction status. Returns: accountTransactionLists, invalidFields, pspReference, resultCode. Required: accountHolderCode. Max 50 transactions per account; increment page to retrieve all transactions.

create_a_adyen_check_account_holder

Trigger verification of an Adyen account holder even when checks are not yet required for its current processing volume. Returns: invalidFields, pspReference, resultCode. Requires accountHolderCode, accountStateType, and tier. The request may be accepted for asynchronous processing (202).

create_a_adyen_close_account_holder

Close an Adyen account holder, setting its status to Closed — this state is final: closed account holders cannot process transactions, pay out funds, or be reopened. Returns: accountHolderStatus, invalidFields, pspReference, resultCode. Required: accountHolderCode. Processing may be asynchronous.

create_a_adyen_close_account

Close an Adyen account permanently. Closed accounts cannot process transactions, pay out funds, or be reopened; payments made afterwards are redirected to your liable account. Returns: accountCode, invalidFields, pspReference, resultCode, status. Required: accountCode.

create_a_adyen_close_store

Close Adyen stores associated with an account holder. Returns: invalidFields, pspReference, resultCode. Required: accountHolderCode, stores.

create_a_adyen_create_account_holder

Create an account holder in Adyen that represents the sub-merchant's entity in your platform. Returns: accountCode, accountHolderCode, accountHolderDetails, accountHolderStatus, pspReference, resultCode, and 6 more. Required: accountHolderCode, accountHolderDetails, legalEntity. The details required depend on the sub-merchant's legal entity type.

create_a_adyen_create_account

Create an account under an account holder in Adyen; an account holder can have multiple accounts. Returns: accountCode, accountHolderCode, bankAccountUUID, description, invalidFields, payoutSchedule, pspReference, resultCode, status, and 3 more. Required: accountHolderCode. The request may be accepted for asynchronous processing before completion.

create_a_adyen_debit_account_holder

Send a direct debit request to an Adyen account holder's bank account. Returns: accountHolderCode, bankAccountUUID, invalidFields, merchantReferences, pspReference, resultCode. Requires accountHolderCode, amount, bankAccountUUID, merchantAccount, splits. The direct debit result arrives via a DIRECT_DEBIT_INITIATED webhook.

create_a_adyen_delete_bank_account

Delete bank accounts associated with an account holder in Adyen. Returns: invalidFields, pspReference, resultCode. May be accepted for asynchronous processing rather than completing immediately. Required: accountHolderCode, bankAccountUUIDs.

create_a_adyen_delete_legal_arrangement

Delete legal arrangements and/or legal arrangement entities associated with an Adyen account holder. Returns: invalidFields, pspReference, resultCode. Required: accountHolderCode, legalArrangements. Processing may be accepted for asynchronous completion (202).

create_a_adyen_delete_payout_method

Delete payout methods associated with an account holder in Adyen. Returns: invalidFields, pspReference, resultCode. Required: accountHolderCode, payoutMethodCodes. May return 202 while the deletion is processed asynchronously.

create_a_adyen_delete_shareholder

Delete shareholders associated with an account holder in Adyen. Returns: invalidFields, pspReference, resultCode. Required: accountHolderCode, shareholderCodes. Processing may be asynchronous (202 Accepted).

create_a_adyen_delete_signatory

Delete signatories associated with an account holder in Adyen. Returns: invalidFields, pspReference, resultCode. Requires accountHolderCode and signatoryCodes. Processing may be asynchronous. Required: accountHolderCode, signatoryCodes.

create_a_adyen_get_uploaded_document

Get documents previously uploaded for an Adyen account holder, used during the verification process. Returns: documentDetails, invalidFields, pspReference, resultCode. Required: accountHolderCode.

create_a_adyen_payout_account_holder

Pay out a specified amount from an Adyen account to the account holder's bank account. Returns: bankAccountUUID, invalidFields, merchantReference, payoutSpeed, pspReference, resultCode. Requires accountCode and accountHolderCode. The request may be accepted for asynchronous processing (202 Accepted). Required: accountCode, accountHolderCode.

create_a_adyen_refund_funds_transfer

Refund funds transferred from one Adyen account to another. Returns: invalidFields, merchantReference, message, originalReference, pspReference, resultCode. Requires amount and originalReference; both accounts must be in the same platform. Required: amount, originalReference.

create_a_adyen_suspend_account_holder

Suspend an account holder in Adyen, changing its status to Suspended. Returns: accountHolderStatus, invalidFields, pspReference, resultCode. Required: accountHolderCode. The request may be accepted for asynchronous processing.

list_all_adyen_tax_form

Generate a tax form for an Adyen account holder operating in the US. Returns: content, contentType, invalidFields, pspReference, resultCode. Requires accountHolderCode, formType, and year. Required: accountHolderCode, formType, year.

create_a_adyen_un_suspend_account_holder

Unsuspend an Adyen account holder, changing its status from Suspended to Inactive. Returns: accountHolderStatus, invalidFields, pspReference, resultCode. Required: accountHolderCode. Only works if the account holder has no FAILED verification checks; processing may be asynchronous.

create_a_adyen_update_account_holder_state

Enable or disable an account holder's processing or payout state in Adyen. Returns: accountHolderCode, accountHolderStatus, invalidFields, pspReference, resultCode. Requires accountHolderCode, stateType, and disable. Required: accountHolderCode, disable, stateType.

create_a_adyen_update_account_holder

Update an Adyen account holder's accountHolderDetails and processingTier, and add bank accounts or shareholders. Returns: accountHolderCode, accountHolderDetails, accountHolderStatus, pspReference, and 7 more. Required: accountHolderCode. Metadata updates replace the whole object; address or phone changes must resubmit all fields for validation.

create_a_adyen_update_account

Update an Adyen account's description or payout schedule. Returns: accountCode, bankAccountUUID, description, invalidFields, metadata, payoutMethodCode, payoutSchedule, payoutSpeed, pspReference, resultCode. Required: accountCode. The request may be accepted for asynchronous processing.

create_a_adyen_upload_document

Upload a document for an Adyen account holder for use in the verification process. Returns: accountHolderCode, accountHolderDetails, accountHolderStatus, description, invalidFields, legalEntity, and 5 more fields. Required: documentContent, documentDetail. Requires documentContent and documentDetail. Processing may continue asynchronously.

create_a_adyen_calculate

Calculate a preliminary offer for a financing amount selected from an Adyen Capital dynamic offer. Returns: accountHolderId, amount, contractType, expiresAt, fee, repayment, startsAt. The offer is informational only and cannot be used to initiate a grant. Required: dynamic_offer_id, id, amount.

create_a_adyen_cashout

Initiate a cashout in Adyen to move funds from a balance account to a counterparty. Returns: amount, counterparty, description, fee, id, instructingBalanceAccountId, referenceForBeneficiary, transferInstrumentId, transfers. Required: amount, instructingBalanceAccountId.

delete_a_adyen_dispute_attachment_by_id

Delete an attachment from a raised dispute in Adyen. Returns an empty 204 response on success. Note that Adyen may retain the removed file for compliance purposes. Required: id, dispute_id, attachmentId.

get_single_adyen_dispute_attachment_by_id

Get a single attachment of a dispute in Adyen. Returns: attachmentType, content, fileName, id. Required: id, dispute_id, attachmentId.

adyen_disputes_attach_attachment

Add a supporting attachment (receipt, communication, or other documentation) to a raised Adyen dispute. Returns: attachmentId. Base64-encoded content must have no line breaks. Required: dispute_id, dispute_id, attachmentType, content, fileName.

create_a_adyen_dispute

Raise an Adyen dispute for an underlying transaction by specifying a dispute type and the amount to dispute. Returns: arn, description, disputedAmount, duplicateInfo, fraudInfo, id, notDeliveredInfo, otherInfo, status, transactionId, type. Required: transactionId, type.

get_single_adyen_dispute_by_id

Get a raised Adyen dispute by id. Returns: arn, description, disputedAmount, duplicateInfo, fraudInfo, id, notDeliveredInfo, otherInfo, status, transactionId, type. Required: id.

list_all_adyen_disputes

List raised disputes in Adyen that match optional filters. Returns matching dispute objects including their id and current status. Max 500 items per page (default 100).

adyen_disputes_list_attachments

List all attachments linked to a raised Adyen dispute. Returns: attachmentType, content, fileName, id. Required: dispute_id.

update_a_adyen_dispute_by_id

Update a raised Adyen dispute's details or change its status from draft to submitted or closed. Returns: arn, description, disputedAmount, duplicateInfo, fraudInfo, id, notDeliveredInfo, otherInfo, status, transactionId, type. Required: id. Moving a dispute to submitted or closed is final and can no longer be updated.

list_all_adyen_dynamic_offers

List all dynamic offers available in Adyen Capital for a given account holder. Returns the matching offers in the dynamicOffers array. Required: accountHolderId.

get_single_adyen_grant_disbursement_by_id

Get the details of a specific disbursement under a grant in Adyen. Returns: accountHolderId, amount, balanceAccountId, balances, fee, fundsCollections, grantId, id, repayment. Required: id, grant_id, disbursementId.

list_all_adyen_grant_disbursements

List all disbursements of a specified grant in Adyen. Returns the disbursements list — each disbursement includes id, grant_id, amount (currency, value), balances (fee, principal, total), fee, repayment (basis points), accountHolderId, balanceAccountId, and fundsCollections. Required: grant_id, grant_id.

update_a_adyen_grant_disbursement_by_id

Update the repayment configuration of a disbursement in Adyen, setting the percentage of your user's net income deducted for repaying the grant. Returns the updated disbursement with id, amount, balances, fee, repayment, accountHolderId, and grantId. Required: id, grant_id, disbursementId.

create_a_adyen_grants_v_1

Request a grant payout in Adyen Capital. Returns the created grant with id, status, grantAccountId, grantOfferId, amount, fee, balances, repayment, and counterparty. Required: grantAccountId, grantOfferId.

get_single_adyen_grants_v_1_by_id

Get reference details for a specific Adyen Capital grant by id. Returns: amount, balances, counterparty, fee, grantAccountId, grantOfferId, id, repayment, status. Required: id.

list_all_adyen_grants_v_1

List all grants issued to a specific account holder in Adyen Capital. Returns each grant with its id, status, amount, balances, repayment terms, and counterparty details. Required: counterpartyAccountHolderId.

get_single_adyen_transaction_by_id

Get a single Adyen transaction by its unique identifier. Returns: accountHolder, amount, balanceAccount, balancePlatform, bookingDate, creationDate, description, id, paymentInstrument, referenceForBeneficiary, status, transfer, valueDate. Required: id.

list_all_adyen_transactions

List Adyen transactions for a balance platform, account holder, or balance account within a time window. Returns: accountHolder, amount, balanceAccount, balancePlatform, bookingDate, creationDate, description, id, paymentInstrument, referenceForBeneficiary, status, transfer, valueDate. Max 100 per page. Required: createdSince, createdUntil.

create_a_adyen_transfer_return

Return previously transferred funds in Adyen without creating a new transfer id. Returns: id, reference, status, transferId. Required: transfer_id, amount.

create_a_adyen_transfer

Create a funds transfer in Adyen to a balance account, transfer instrument, third-party bank account, or card. Returns the accepted transfer object including id, status, amount, category, counterparty. Required: amount, category, counterparty. Requires amount, category, and counterparty.

get_single_adyen_transfer_by_id

Get the details of an Adyen transfer by id. Returns the full transfer object including id, status, amount, category, counterparty, balanceAccount, balances, and events. Required: id.

list_all_adyen_transfers

List Adyen transfers for a balance platform, account holder, or balance account. Returns transfers with id, status, amount, category, and counterparty. Requires createdSince, createdUntil, and one of balanceAccountId, accountHolderId, or balancePlatform. The date range must span at most 6 months. Required: createdSince, createdUntil.

create_a_adyen_transfers_approve

Approve initiated transfers in Adyen that triggered an additional review. Returns an empty 204 response on success; the approval outcome is delivered through webhooks. Requires a transferIds array of transfer IDs to approve.

create_a_adyen_transfers_cancel

Cancel initiated transfers in Adyen by submitting a list of transfers that triggered an additional review for cancellation. Returns an empty 200 response on success - the outcome of the cancel request is delivered through webhooks.

create_a_adyen_accept_dispute

Accept a dispute in Adyen. Returns the disputeServiceResult object with a success flag and, on failure, an errorMessage. Required: disputePspReference, merchantAccountCode.

get_single_adyen_account_verification_report_by_id

Get an Adyen account verification report using the unique code from a successful open banking connection. Returns: accounts, country, id. Required: id.

create_a_adyen_account_verification_route

Create routes for verifying third-party bank accounts in Adyen's open banking gateway. Returns the available bank routes for the specified country, each with its provider details and redirect link. Requires country and redirectUrl. Required: country, redirectUrl.

list_all_adyen_applicable_defense_reasons

List the applicable defense reasons in Adyen that can be used to defend a specific dispute. Returns: defenseReasons, disputeServiceResult. Required: disputePspReference, merchantAccountCode.

create_a_adyen_assign_terminal

Assign one or more payment terminals to a company account, merchant account, or store in Adyen, or unassign terminals back to company inventory. Returns: results. Deprecated: support ends April 1, 2025 — use the Management API for terminal fleet automation. Required: companyAccount, terminals.

create_a_adyen_auth_certificate

Create a communication session in Adyen, establishing a secure mutually-authenticated channel between the Mobile SDK and the payments platform by exchanging a setup token for a session token. Returns: id, installationId, merchantAccount, sdkData, store. Required: merchantAccount, setupToken.

create_a_adyen_balance_transfer

Create a balance transfer between two Adyen merchant accounts. Returns: createdAt, pspReference. Required: amount, fromMerchant, toMerchant, type. Both accounts must be under the same company account and legal entity; send requests sequentially, not in parallel.

create_a_adyen_change_status

Change the status of a stored payment method in Adyen's Stored Value API. Returns the change result including pspReference, resultCode, authCode, currentBalance, and refusalReason when the request is refused. Required: merchantAccount, paymentMethod, reference, status.

create_a_adyen_check_balance

Check the balance of a provided payment method in Adyen. Returns: currentBalance, pspReference, refusalReason, resultCode, thirdPartyRefusalReason. Required: merchantAccount, paymentMethod, reference.

list_all_adyen_companie_balances

List the available balances for all merchant accounts under an Adyen company account. Returns per merchant account: merchantAccount, availableFund, pendingBalance, nextPayout, reserve, and deposit (each amount as value and currency). Required: company_account_code, currency.

create_a_adyen_create_notification_configuration

Create a notification subscription in Adyen so events on your platform are sent to the endpoint specified in the configuration. Returns: configurationDetails, invalidFields, pspReference, resultCode. Required: configurationDetails. Subscriptions are configured on a per-event basis.

create_a_adyen_create_test_card_range

Create one or more test card ranges in Adyen. Returns: rangeCreationResults. Required: accountCode, accountTypeCode, testCardRanges.

create_a_adyen_defend_dispute

Defend a dispute in Adyen by submitting a defense for a specific dispute. Returns: disputeServiceResult. Required: defenseReasonCode, disputePspReference, merchantAccountCode.

create_a_adyen_delete_dispute_defense_document

Delete a dispute defense document that was previously supplied for a dispute in Adyen. Returns the dispute service result (disputeServiceResult) with success and errorMessage. Required: defenseDocumentType, disputePspReference, merchantAccountCode.

create_a_adyen_delete_notification_configuration

Delete Adyen notification subscription configurations. Returns: invalidFields, pspReference, resultCode. After deletion, no further event notifications are sent to the subscription's URL. Required: notificationIds.

create_a_adyen_device_async

Send a Terminal API request to an Adyen payment device and receive the response asynchronously. Returns 200 OK when the device is online; the actual Terminal API response is delivered as an event notification webhook. Required: merchant_account, device_id.

get_single_adyen_device_status_by_id

Get the cloud connection status of a payment terminal or Mobile SDK device in Adyen. Returns: deviceId, status. Required: id, merchant_account, merchant_account, deviceId.

create_a_adyen_device_sync

Send a Terminal API request to an Adyen payment device and receive the response synchronously. Returns the Terminal API response; its structure varies by request type. Required: merchant_account, device_id (terminal ID such as P400-123456789 or the Mobile SDK installation ID).

create_a_adyen_get_onboarding_url

Get a link to an Adyen-hosted onboarding page (HOP) to send to your account holder. Returns: invalidFields, pspReference, redirectUrl, resultCode. Requires accountHolderCode. Required: accountHolderCode.

create_a_adyen_get_pci_questionnaire_url

Get a link to a PCI compliance questionnaire that can be sent to an account holder in Adyen. Returns: invalidFields, pspReference, redirectUrl, resultCode. Required: accountHolderCode. Only for partner platform setups.

create_a_adyen_issue

Issue a new stored value card of the given payment method in Adyen. Returns: authCode, currentBalance, paymentMethod, pspReference, refusalReason, resultCode, thirdPartyRefusalReason. Requires merchantAccount, paymentMethod, and reference. Required: merchantAccount, paymentMethod, reference.

create_a_adyen_load

Load funds onto an Adyen stored value payment method, such as a gift card. Returns: authCode, currentBalance, pspReference, refusalReason, resultCode, thirdPartyRefusalReason. Required: amount, merchantAccount, paymentMethod, reference.

create_a_adyen_login

Create a login session for an Adyen payment device, starting the processing period between a Login and the following Logout. Returns: Response, POISystemData, TokenRequestStatus. Required: merchant_account, device_id, DateTime, SaleSoftware, OperatorLanguage.

create_a_adyen_logout

Request a synchronous logout for a device in Adyen. Returns: Response. Required: merchant_account, device_id.

list_all_adyen_merchant_balances

List the balances available for an Adyen merchant account, including settled funds, pending balance, next payout, reserve, and deposit. Returns: merchantAccount, availableFund, pendingBalance, nextPayout, reserve, deposit. Required: merchant_account_code, currency.

list_all_adyen_merchant_connected_devices

List the Adyen payment terminals or SDK installation IDs (in a Mobile solution) that have an active cloud connection under a merchant account. Returns: uniqueDeviceIds. Required: merchant_account, merchant_account.

create_a_adyen_merchant_generate_payments_app_boarding_token

Create a merchant-level boarding token in Adyen that authenticates the installation of a Payments App instance on a device. Returns: boardingToken, installationId. Required: merchant_id, boardingRequestToken.

list_all_adyen_merchant_payments_apps

List Payments App instances for a merchant account in Adyen. Returns: paymentsApps. Required: merchant_id.

adyen_merchant_payments_apps_revoke

Revoke the authentication of a Payments App instance in Adyen for both merchant accounts and stores. Returns an empty response on success. Required: merchant_id, installation_id.

create_a_adyen_merge_balance

Merge the balance of two Adyen stored-value cards, transferring the full remaining amount from the source card to the target payment method. Returns: authCode, currentBalance, pspReference, refusalReason, resultCode, thirdPartyRefusalReason. Required: merchantAccount, paymentMethod, reference, sourcePaymentMethod.

list_all_adyen_notification_configuration_list

List every notification subscription configuration in the Adyen platform for the executing user. Returns each configuration's id and schema-defined attributes; the full field set is defined by Adyen's GetNotificationConfigurationListResponse schema.

list_all_adyen_notification_configurations

Get the details of a notification subscription configuration in Adyen. Returns: configurationDetails, invalidFields, pspReference, resultCode. Required: notificationId.

create_a_adyen_payments_cancel

Cancel a payment in Adyen using its payment token. Returns: links. Required: token.

create_a_adyen_payments_confirm

Confirm a payment in Adyen using Strong Customer Authentication. Returns: links. Requires token and balanceAccountId. Call twice: first to initiate SCA, then again with the updated WWW-Authenticate header after the user completes the challenge. Required: balanceAccountId, token.

create_a_adyen_profile_auth_link

Generate a redirection URL to manage an already registered iDEAL profile in Adyen. Returns the redirectUrl containing the href the user must be redirected to. Required: accountHolderId. The account holder must already have an iDEAL profile registered.

create_a_adyen_profile_authenticate

Authenticate an iDEAL profile in Adyen and obtain a redirect URL to finish the authentication flow. Returns: redirectUrl. Requires accountHolderId and payload. The user must have completed multi-factor authentication before calling, and the payload expires. Required: accountHolderId, payload.

create_a_adyen_profile_register

Register a new iDEAL profile in Adyen, linked to the account holder and payment instruments supplied in the request. Returns: redirectUrl. Required: accountHolderId, paymentInstrumentIds.

create_a_adyen_refund_not_paid_out_transfer

Refund all transactions of an Adyen account since the most recent payout; only the portion of each payment made to the specified account is refunded. Returns: invalidFields, pspReference, resultCode. Required: accountCode, accountHolderCode. Processing may complete asynchronously.

create_a_adyen_request_subject_erasure

Submit a subject erasure request to Adyen's Data Protection Service to delete shopper data by sending the PSP reference of the transactions containing it. Returns: result.

create_a_adyen_setup_beneficiary

Designate a beneficiary account in Adyen and transfer the benefactor's current balance to it. Returns: invalidFields, pspReference, resultCode. Requires sourceAccountCode and destinationAccountCode. A beneficiary chain may not exceed four beneficiaries or contain cycles. Required: destinationAccountCode, sourceAccountCode.

create_a_adyen_store_generate_payments_app_boarding_token

Generate a store-level boarding token in Adyen used to authenticate the installation of a Payments App instance on a device. Returns: boardingToken, installationId. Required: merchant_id, store_id, boardingRequestToken.

list_all_adyen_store_payments_apps

List the Payments App instances for a specific store in Adyen. Returns the paymentsApps array of Payments App records. Max 100 per page. Required: merchant_id, store_id.

list_all_adyen_stores_under_account

List the stores of an Adyen company or merchant account, including the status of each store. Returns: stores. Required: companyAccount. This POS Terminal Management API endpoint is deprecated; use the Management API for terminal fleet management instead.

create_a_adyen_supply_defense_document

Supply a defense document for an Adyen dispute. Returns: disputeServiceResult. Required: defenseDocuments, disputePspReference, merchantAccountCode.

list_all_adyen_terminal_details

Get the details of an Adyen payment terminal, including where it is assigned. Returns: bluetoothIp, bluetoothMac, companyAccount, deviceModel, firmwareVersion, merchantAccount, serialNumber, store, storeDetails, terminal, terminalStatus, and 14 more. Required: terminal. The POS Terminal Management API is deprecated and support stops April 1, 2025.

list_all_adyen_terminals_under_account

List Adyen payment terminals under a company account, merchant account, or store, showing whether each is in inventory or in-store. Returns: companyAccount, inventoryTerminals, merchantAccounts. Required: companyAccount. Deprecated: support ends April 1, 2025 — use the Management API instead.

create_a_adyen_test_notification_configuration

Test an existing Adyen notification configuration by generating a test notification for each specified event type and sending it to the subscription's configured URL. Returns: errorMessages, eventTypes, exchangeMessages, invalidFields, notificationId, okMessages, pspReference, resultCode. Required: notificationId.

create_a_adyen_transfer_fund

Transfer funds between two accounts in the same Adyen platform. Returns: invalidFields, merchantReference, pspReference, resultCode. Required: amount, sourceAccountCode, destinationAccountCode, transferCode. Processing may be asynchronous (202 Accepted).

create_a_adyen_update_notification_configuration

Update an existing notification subscription configuration in Adyen. Returns: configurationDetails, invalidFields, pspReference, resultCode. Required: configurationDetails. When updating event types, all event types must be provided or the previous event type configuration will be overwritten.

create_a_adyen_void_transaction

Void a stored value transaction in Adyen. Returns: currentBalance, pspReference, refusalReason, resultCode, thirdPartyRefusalReason. Required: merchantAccount, originalReference.

create_a_adyen_abort

Abort an ongoing payment transaction on a payment device by sending an AbortRequest. Returns 200 OK with no response body. Required: merchant_account, device_id, MessageReference, AbortReason.

create_a_adyen_admin

Send a custom admin request to an Adyen device, with ServiceIdentification in the request body. Returns the AdminResponse containing its Response object. Required: merchant_account, device_id.

create_a_adyen_balanceinquiry

Perform a synchronous balance inquiry on a payment device in Adyen, returning the balance and identification of the associated payment, loyalty, or stored value account. Returns: Response, PaymentAccountStatus, PaymentReceipt. Required: merchant_account, device_id.

create_a_adyen_cardacquisition

Create an Adyen card acquisition request to read and analyse payment and loyalty cards on a device, typically followed by a payment or loyalty transaction referencing it. Returns: Response, SaleData, POIData, PaymentBrand, PaymentInstrumentData, LoyaltyAccount. Required: merchant_account, device_id, SaleData, CardAcquisitionTransaction.

create_a_adyen_cardreaderapdus

Send a Card Reader APDU request to the chip of a card on an Adyen device. Returns: Response, APDUData, CardStatusWords. Required: merchant_account, device_id, APDUClass, APDUInstruction, APDUPar1, APDUPar2.

create_a_adyen_cross_border_invoice

Upload a cross-border invoice document to Adyen for a merchant account. Returns: context, fileName, merchantAccount, pspReference. Requires file, context, and merchantAccount. The file must be a PDF named {pspReference}.pdf. Required: context, file, merchantAccount.

create_a_adyen_diagnosis

Run a synchronous diagnosis on a payment device (POI) in Adyen to retrieve information about the target terminal. Returns: Response, POIStatus, HostStatus. Required: merchant_account, device_id.

create_a_adyen_display

Send a display request to a device in Adyen, conveying the complete content to display and how to process it for each display device type. Returns: OutputResult. Required: merchant_account, device_id, DisplayOutput.

create_a_adyen_enableservice

Enable one or more services on an Adyen POI terminal without a Sale System request, optionally inviting the customer to start them. Returns the Enable Service processing result in Response. Required: merchant_account, device_id, TransactionAction.

create_a_adyen_gettotal

Request totals from an Adyen payment device (POI), conveying the scope and format of the totals to be computed. Returns: Response, POIReconciliationID, TransactionTotals. Required: merchant_account, device_id.

create_a_adyen_input

Send an input request to an Adyen device, conveying data to display and how to process it. Returns: OutputResult, InputResult. Required: merchant_account, device_id, InputData.

create_a_adyen_print

Send a print request to a specific device in an Adyen merchant account, conveying the complete data to print and how to process it. Returns: DocumentQualifier, Response. Required: merchant_account, device_id, PrintOutput.

create_a_adyen_rates_calculate

Calculate the amounts and exchange rates required to convert a transaction's currency in Adyen. Returns exchangeCalculations, each with type, exchangeSide, sourceAmount, targetAmount, and appliedExchangeRate. Required: exchangeCalculations.

create_a_adyen_reconciliation

Request a reconciliation for a payment device in Adyen, sending the device's reconciliation details to the Sale System. Returns: Response, ReconciliationType, POIReconciliationID, TransactionTotals. Required: merchant_account, device_id, ReconciliationType.

create_a_adyen_reversal

Create a synchronous reversal request for a previous payment or loyalty transaction on an Adyen POI device. Returns: Response, POIData, OriginalPOITransaction, ReversedAmount, PaymentReceipt. Required: merchant_account, device_id, OriginalPOITransaction, ReversalReason.

create_a_adyen_storedvalue

Process a stored value transaction on an Adyen payment device synchronously. Returns: Response, SaleData, POIData, StoredValueResult, PaymentReceipt. Required: merchant_account, device_id, SaleData, StoredValueData.

create_a_adyen_transactionstatus

Check the status of the last or current payment, loyalty, or reversal transaction on an Adyen POS device. Returns: Response, MessageReference, RepeatedMessageResponse. Required: merchant_account, device_id.