Adyen

Process payments across various sales channels with Adyen.

Authentication

This connector uses Token-based authentication.

info

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

How to use

Using the Smart Chat

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

Using the Web Editor

from abstra.connectors import run_connection_action

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

Available Actions

This connector provides 402 actions:

Action	Parameters
account_service/post_check_account_holder	data: { . accountHolderCode (string) . accountStateType (string) . tier (integer) } (object) required
account_service/post_close_account	data: { . accountCode (string) } (object) required
account_service/post_close_account_holder	data: { . accountHolderCode (string) } (object) required
account_service/post_close_stores	data: { . accountHolderCode (string) . stores (array) } (object) required
account_service/post_create_account	data: { . accountHolderCode (string) . bankAccountUUID (string) . description (string) . metadata (object) . payoutMethodCode (string) . payoutSchedule (string) . payoutScheduleReason (string) . payoutSpeed (string) } (object) required
account_service/post_create_account_holder	data: { . accountHolderCode (string) . accountHolderDetails . createDefaultAccount (boolean) . description (string) . legalEntity (string) . primaryCurrency (string) . processingTier (integer) . verificationProfile (string) } (object) required
account_service/post_delete_bank_accounts	data: { . accountHolderCode (string) . bankAccountUUIDs (array) } (object) required
account_service/post_delete_legal_arrangements	data: { . accountHolderCode (string) . legalArrangements (array) } (object) required
account_service/post_delete_payout_methods	data: { . accountHolderCode (string) . payoutMethodCodes (array) } (object) required
account_service/post_delete_shareholders	data: { . accountHolderCode (string) . shareholderCodes (array) } (object) required
account_service/post_delete_signatories	data: { . accountHolderCode (string) . signatoryCodes (array) } (object) required
account_service/post_get_account_holder	data: { . accountCode (string) . accountHolderCode (string) . showDetails (boolean) } (object) required
account_service/post_get_tax_form	data: { . accountHolderCode (string) . formType (string) . year (integer) } (object) required
account_service/post_get_uploaded_documents	data: { . accountHolderCode (string) . bankAccountUUID (string) . shareholderCode (string) } (object) required
account_service/post_suspend_account_holder	data: { . accountHolderCode (string) } (object) required
account_service/post_un_suspend_account_holder	data: { . accountHolderCode (string) } (object) required
account_service/post_update_account	data: { . accountCode (string) . bankAccountUUID (string) . description (string) . metadata (object) . payoutMethodCode (string) . payoutSchedule . payoutSpeed (string) } (object) required
account_service/post_update_account_holder	data: { . accountHolderCode (string) . accountHolderDetails . description (string) . legalEntity (string) . primaryCurrency (string) . processingTier (integer) . verificationProfile (string) } (object) required
account_service/post_update_account_holder_state	data: { . accountHolderCode (string) . disable (boolean) . reason (string) . stateType (string) } (object) required
account_service/post_upload_document	data: { . documentContent (string) . documentDetail } (object) required
balance_control_service/post_balance_transfer	data: { . amount . description (string) . fromMerchant (string) . reference (string) . toMerchant (string) . type (string) } (object) required
balance_platform_service/post_account_holders	data: { . balancePlatform (string) . capabilities (object) . contactDetails . description (string) . legalEntityId (string) . metadata (object) . migratedAccountHolderCode (string) . reference (string) . timeZone (string) } (object) required
balance_platform_service/get_account_holders_by_id	id (string)
balance_platform_service/patch_account_holders_by_id	id (string) data: { . balancePlatform (string) . capabilities (object) . contactDetails . description (string) . metadata (object) . migratedAccountHolderCode (string) . primaryBalanceAccount (string) . reference (string) . status (string) . timeZone (string) . verificationDeadlines (array) } (object) required
balance_platform_service/get_account_holders_by_id_balance_accounts	id (string) offset (integer) limit (integer)
balance_platform_service/get_account_holders_by_id_tax_forms	id (string) formType (string) required year (integer) required legalEntityId (string)
balance_platform_service/get_account_holders_by_id_transaction_rules	id (string)
balance_platform_service/post_balance_accounts	data: { . accountHolderId (string) . defaultCurrencyCode (string) . description (string) . metadata (object) . migratedAccountCode (string) . platformPaymentConfiguration . reference (string) . timeZone (string) } (object) required
balance_platform_service/get_balance_accounts_by_balance_account_id_sweeps	balanceAccountId (string) offset (integer) limit (integer)
balance_platform_service/post_balance_accounts_by_balance_account_id_sweeps	balanceAccountId (string) data: { . category (string) . counterparty . currency (string) . description (string) . priorities (array) . reason (string) . reasonDetail (string) . reference (string) . referenceForBeneficiary (string) . schedule . status (string) . sweepAmount . targetAmount . triggerAmount . type (string) } (object) required
balance_platform_service/get_balance_accounts_by_balance_account_id_sweeps_by_sweep_id	balanceAccountId (string) sweepId (string)
balance_platform_service/delete_balance_accounts_by_balance_account_id_sweeps_by_sweep_id	balanceAccountId (string) sweepId (string)
balance_platform_service/patch_balance_accounts_by_balance_account_id_sweeps_by_sweep_id	balanceAccountId (string) sweepId (string) data: { . category (string) . counterparty . currency (string) . description (string) . id (string) . priorities (array) . reason (string) . reasonDetail (string) . reference (string) . referenceForBeneficiary (string) . schedule . status (string) . sweepAmount . targetAmount . triggerAmount . type (string) } (object) required
balance_platform_service/get_balance_accounts_by_id	id (string)
balance_platform_service/patch_balance_accounts_by_id	id (string) data: { . accountHolderId (string) . description (string) . metadata (object) . platformPaymentConfiguration . reference (string) . status (string) . timeZone (string) } (object) required
balance_platform_service/get_balance_accounts_by_id_payment_instruments	id (string) offset (integer) limit (integer) status (string)
balance_platform_service/get_balance_accounts_by_id_transaction_rules	id (string)
balance_platform_service/get_balance_platforms_by_id	id (string)
balance_platform_service/get_balance_platforms_by_id_account_holders	id (string) offset (integer) limit (integer)
balance_platform_service/get_balance_platforms_by_id_transaction_rules	id (string)
balance_platform_service/get_cardorders	id (string) cardManufacturingProfileId (string) status (string) txVariantCode (string) createdSince (string) createdUntil (string) lockedSince (string) lockedUntil (string) serviceCenter (string) offset (integer) limit (integer)
balance_platform_service/get_cardorders_by_id_items	id (string) offset (integer) limit (integer)
balance_platform_service/get_grant_accounts_by_id	id (string)
balance_platform_service/get_grant_offers	accountHolderId (string) required
balance_platform_service/get_grant_offers_by_grant_offer_id	grantOfferId (string)
balance_platform_service/get_network_tokens_by_network_token_id	networkTokenId (string)
balance_platform_service/patch_network_tokens_by_network_token_id	networkTokenId (string) data: { . status (string) } (object) required
balance_platform_service/post_payment_instrument_groups	data: { . balancePlatform (string) . description (string) . properties (object) . reference (string) . txVariant (string) } (object) required
balance_platform_service/get_payment_instrument_groups_by_id	id (string)
balance_platform_service/get_payment_instrument_groups_by_id_transaction_rules	id (string)
balance_platform_service/post_payment_instruments	data: { . balanceAccountId (string) . bankAccount . card . description (string) . issuingCountryCode (string) . paymentInstrumentGroupId (string) . reference (string) . status (string) . statusComment (string) . statusReason (string) . type (string) } (object) required
balance_platform_service/post_payment_instruments_reveal	data: { . encryptedKey (string) . paymentInstrumentId (string) } (object) required
balance_platform_service/get_payment_instruments_by_id	id (string)
balance_platform_service/patch_payment_instruments_by_id	id (string) data: { . balanceAccountId (string) . card . status (string) . statusComment (string) . statusReason (string) } (object) required
balance_platform_service/get_payment_instruments_by_id_network_token_activation_data	id (string)
balance_platform_service/post_payment_instruments_by_id_network_token_activation_data	id (string) data: { . sdkOutput (string) } (object) required
balance_platform_service/get_payment_instruments_by_id_network_tokens	id (string)
balance_platform_service/get_payment_instruments_by_id_reveal	id (string)
balance_platform_service/get_payment_instruments_by_id_transaction_rules	id (string)
balance_platform_service/post_pins_change	data: { . encryptedKey (string) . encryptedPinBlock (string) . paymentInstrumentId (string) . token (string) } (object) required
balance_platform_service/post_pins_reveal	data: { . encryptedKey (string) . paymentInstrumentId (string) } (object) required
balance_platform_service/get_public_key	purpose (string) format (string)
balance_platform_service/get_registered_devices	paymentInstrumentId (string) required pageNumber (integer) pageSize (integer)
balance_platform_service/post_registered_devices	data: { . name (string) . paymentInstrumentId (string) . strongCustomerAuthentication } (object) required
balance_platform_service/post_registered_devices_by_device_id_associations	deviceId (string) data: { . ids (array) . type (string) } (object) required
balance_platform_service/patch_registered_devices_by_device_id_associations	deviceId (string) data: { . ids (array) . strongCustomerAuthentication . type (string) } (object) required
balance_platform_service/delete_registered_devices_by_id	id (string) paymentInstrumentId (string) required
balance_platform_service/patch_registered_devices_by_id	id (string) data: { . name (string) . paymentInstrumentId (string) . strongCustomerAuthentication } (object) required
balance_platform_service/post_transaction_rules	data: { . aggregationLevel (string) . description (string) . endDate (string) . entityKey . interval . outcomeType (string) . reference (string) . requestType (string) . ruleRestrictions . score (integer) . startDate (string) . status (string) . type (string) } (object) required
balance_platform_service/get_transaction_rules_by_transaction_rule_id	transactionRuleId (string)
balance_platform_service/delete_transaction_rules_by_transaction_rule_id	transactionRuleId (string)
balance_platform_service/patch_transaction_rules_by_transaction_rule_id	transactionRuleId (string) data: { . aggregationLevel (string) . description (string) . endDate (string) . entityKey . interval . outcomeType (string) . reference (string) . requestType (string) . ruleRestrictions . score (integer) . startDate (string) . status (string) . type (string) } (object) required
balance_platform_service/post_transfer_routes_calculate	data: { . balanceAccountId (string) . balancePlatform (string) . category (string) . counterparty . country (string) . currency (string) . priorities (array) } (object) required
balance_platform_service/post_validate_bank_account_identification	data: { . accountIdentification } (object) required
balance_platform_service/get_payment_instruments_by_payment_instrument_id_authorised_card_users	paymentInstrumentId (string)
balance_platform_service/post_payment_instruments_by_payment_instrument_id_authorised_card_users	paymentInstrumentId (string) data: { . legalEntityIds (array) } (object) required
balance_platform_service/delete_payment_instruments_by_payment_instrument_id_authorised_card_users	paymentInstrumentId (string)
balance_platform_service/patch_payment_instruments_by_payment_instrument_id_authorised_card_users	paymentInstrumentId (string) data: { . legalEntityIds (array) } (object) required
balance_platform_service/get_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings	balancePlatformId (string) webhookId (string)
balance_platform_service/post_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings	balancePlatformId (string) webhookId (string) data: { . conditions (array) . currency (string) . status (string) . target . type (string) } (object) required
balance_platform_service/get_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_id	balancePlatformId (string) webhookId (string) settingId (string)
balance_platform_service/delete_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_id	balancePlatformId (string) webhookId (string) settingId (string)
balance_platform_service/patch_balance_platforms_by_balance_platform_id_webhooks_by_webhook_id_settings_by_setting_id	balancePlatformId (string) webhookId (string) settingId (string) data: { . conditions (array,null) . currency (string) . status (string) . target . type (string) } (object) required
balance_platform_service/post_balance_accounts_by_id_transfer_limits_approve	id (string) WWW-Authenticate (string) data: { . transferLimitIds (array) } (object) required
balance_platform_service/get_balance_accounts_by_id_transfer_limits	id (string) scope (string) transferType (string) status (string)
balance_platform_service/post_balance_accounts_by_id_transfer_limits	id (string) WWW-Authenticate (string) data: { . amount . endsAt (string) . reference (string) . scaInformation . scope . startsAt (string) . transferType } (object) required
balance_platform_service/get_balance_accounts_by_id_transfer_limits_current	id (string) scope (string) transferType (string)
balance_platform_service/get_balance_accounts_by_id_transfer_limits_by_transfer_limit_id	transferLimitId (string) id (string)
balance_platform_service/delete_balance_accounts_by_id_transfer_limits_by_transfer_limit_id	transferLimitId (string) id (string)
balance_platform_service/get_balance_platforms_by_id_transfer_limits	id (string) scope (string) transferType (string) status (string)
balance_platform_service/post_balance_platforms_by_id_transfer_limits	id (string) data: { . amount . endsAt (string) . reference (string) . scaInformation . scope . startsAt (string) . transferType } (object) required
balance_platform_service/get_balance_platforms_by_id_transfer_limits_by_transfer_limit_id	transferLimitId (string) id (string)
balance_platform_service/delete_balance_platforms_by_id_transfer_limits_by_transfer_limit_id	transferLimitId (string) id (string)
bin_lookup_service/post_get3ds_availability	data: { . additionalData (object) . brands (array) . cardNumber (string) . merchantAccount (string) . recurringDetailReference (string) . shopperReference (string) } (object) required
bin_lookup_service/post_get_cost_estimate	data: { . amount . assumptions . cardNumber (string) . encryptedCardNumber (string) . merchantAccount (string) . merchantDetails . recurring . selectedRecurringDetailReference (string) . shopperInteraction (string) . shopperReference (string) } (object) required
capital_service/get_grants	counterpartyAccountHolderId (string) required
capital_service/post_grants	data: { . amount . counterparty . grantAccountId (string) . grantOfferId (string) } (object) required
capital_service/get_grants_by_grant_id	grantId (string)
capital_service/get_grants_by_grant_id_disbursements_by_disbursement_id	grantId (string) disbursementId (string)
capital_service/patch_grants_by_grant_id_disbursements_by_disbursement_id	grantId (string) disbursementId (string) data: { . repayment } (object) required
capital_service/get_grants_by_grant_id_disbursements	grantId (string)
capital_service/get_grant_accounts_by_id	id (string)
capital_service/get_grant_offers_by_id	id (string)
capital_service/get_grant_offers	accountHolderId (string)
checkout_service/post_apple_pay_sessions	Idempotency-Key (string) data: { . displayName (string) . domainName (string) . merchantIdentifier (string) } (object) required
checkout_service/post_cancels	Idempotency-Key (string) data: { . applicationInfo . enhancedSchemeData . merchantAccount (string) . paymentReference (string) . reference (string) } (object) required
checkout_service/post_card_details	Idempotency-Key (string) data: { . cardNumber (string) . countryCode (string) . encryptedCardNumber (string) . merchantAccount (string) . supportedBrands (array) } (object) required
checkout_service/post_donation_campaigns	Idempotency-Key (string) data: { . currency (string) . locale (string) . merchantAccount (string) } (object) required
checkout_service/post_donations	Idempotency-Key (string) data: { . accountInfo . additionalData (object) . amount . applicationInfo . authenticationData . billingAddress . browserInfo . channel (string) . checkoutAttemptId (string) . conversionId (string) . countryCode (string) . dateOfBirth (string) . deliverAt (string) . deliveryAddress . deviceFingerprint (string) . donationAccount (string) . donationCampaignId (string) . donationOriginalPspReference (string) . donationToken (string) . lineItems (array) . merchantAccount (string) . merchantRiskIndicator . metadata (object) . mpiData . origin (string) . paymentMethod . recurringProcessingModel (string) . redirectFromIssuerMethod (string) . redirectToIssuerMethod (string) . reference (string) . returnUrl (string) . sessionValidity (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . socialSecurityNumber (string) . telephoneNumber (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) } (object) required
checkout_service/post_orders	Idempotency-Key (string) data: { . amount . expiresAt (string) . merchantAccount (string) . reference (string) } (object) required
checkout_service/post_orders_cancel	Idempotency-Key (string) data: { . merchantAccount (string) . order } (object) required
checkout_service/post_origin_keys	Idempotency-Key (string) data: { . originDomains (array) } (object) required
checkout_service/post_payment_links	Idempotency-Key (string) data: { . allowedPaymentMethods (array) . amount . applicationInfo . billingAddress . blockedPaymentMethods (array) . captureDelayHours (integer) . countryCode (string) . dateOfBirth (string) . deliverAt (string) . deliveryAddress . description (string) . expiresAt (string) . fundOrigin . fundRecipient . installmentOptions (object) . lineItems (array) . manualCapture (boolean) . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . metadata (object) . platformChargebackLogic . recurringProcessingModel (string) . reference (string) . requiredShopperFields (array) . returnUrl (string) . reusable (boolean) . riskData . shopperEmail (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . showRemovePaymentMethodButton (boolean) . socialSecurityNumber (string) . splitCardFundingSources (boolean) . splits (array) . store (string) . storePaymentMethodMode (string) . telephoneNumber (string) . themeId (string) . threeDS2RequestData } (object) required
checkout_service/get_payment_links_by_link_id	linkId (string)
checkout_service/patch_payment_links_by_link_id	linkId (string) data: { . status (string) } (object) required
checkout_service/post_payment_methods	Idempotency-Key (string) data: { . additionalData (object) . allowedPaymentMethods (array) . amount . blockedPaymentMethods (array) . browserInfo . channel (string) . countryCode (string) . merchantAccount (string) . order . shopperConversionId (string) . shopperEmail (string) . shopperIP (string) . shopperLocale (string) . shopperReference (string) . splitCardFundingSources (boolean) . store (string) . storeFiltrationMode (string) . telephoneNumber (string) } (object) required
checkout_service/post_payment_methods_balance	Idempotency-Key (string) data: { . accountInfo . additionalAmount . additionalData (object) . amount . applicationInfo . billingAddress . browserInfo . captureDelayHours (integer) . dateOfBirth (string) . dccQuote . deliveryAddress . deliveryDate (string) . deviceFingerprint (string) . fraudOffset (integer) . installments . localizedShopperStatement (object) . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . merchantRiskIndicator . metadata (object) . orderReference (string) . paymentMethod (object) . recurring . recurringProcessingModel (string) . reference (string) . selectedBrand (string) . selectedRecurringDetailReference (string) . sessionId (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . socialSecurityNumber (string) . splits (array) . store (string) . telephoneNumber (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) . totalsGroup (string) . trustedShopper (boolean) } (object) required
checkout_service/post_payments	Idempotency-Key (string) data: { . accountInfo . additionalAmount . additionalData (object) . amount . applicationInfo . authenticationData . bankAccount . billingAddress . browserInfo . captureDelayHours (integer) . channel (string) . checkoutAttemptId (string) . company . conversionId (string) . countryCode (string) . dateOfBirth (string) . dccQuote . deliverAt (string) . deliveryAddress . deliveryDate (string) . deviceFingerprint (string) . enableOneClick (boolean) . enablePayOut (boolean) . enableRecurring (boolean) . enhancedSchemeData . entityType (string) . fraudOffset (integer) . fundOrigin . fundRecipient . industryUsage (string) . installments . lineItems (array) . localizedShopperStatement (object) . mandate . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . merchantRiskIndicator . metadata (object) . mpiData . order . orderReference (string) . origin (string) . paymentMethod . platformChargebackLogic . recurringExpiry (string) . recurringFrequency (string) . recurringProcessingModel (string) . redirectFromIssuerMethod (string) . redirectToIssuerMethod (string) . reference (string) . returnUrl (string) . riskData . sdkData (string) . sessionValidity (string) . shopperConversionId (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . socialSecurityNumber (string) . splits (array) . store (string) . storePaymentMethod (boolean) . subMerchants (array) . surcharge . telephoneNumber (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) . trustedShopper (boolean) } (object) required
checkout_service/post_payments_details	Idempotency-Key (string) data: { . authenticationData . details . paymentData (string) . threeDSAuthenticationOnly (boolean) } (object) required
checkout_service/post_payments_by_payment_psp_reference_amount_updates	paymentPspReference (string) Idempotency-Key (string) data: { . amount . applicationInfo . enhancedSchemeData . industryUsage (string) . lineItems (array) . merchantAccount (string) . reference (string) . splits (array) } (object) required
checkout_service/post_payments_by_payment_psp_reference_cancels	paymentPspReference (string) Idempotency-Key (string) data: { . applicationInfo . enhancedSchemeData . merchantAccount (string) . reference (string) } (object) required
checkout_service/post_payments_by_payment_psp_reference_captures	paymentPspReference (string) Idempotency-Key (string) data: { . amount . applicationInfo . enhancedSchemeData . lineItems (array) . merchantAccount (string) . platformChargebackLogic . reference (string) . splits (array) . subMerchants (array) } (object) required
checkout_service/post_payments_by_payment_psp_reference_refunds	paymentPspReference (string) Idempotency-Key (string) data: { . amount . applicationInfo . capturePspReference (string) . enhancedSchemeData . lineItems (array) . merchantAccount (string) . merchantRefundReason (string) . reference (string) . splits (array) . store (string) } (object) required
checkout_service/post_payments_by_payment_psp_reference_reversals	paymentPspReference (string) Idempotency-Key (string) data: { . applicationInfo . enhancedSchemeData . merchantAccount (string) . reference (string) } (object) required
checkout_service/post_paypal_update_order	Idempotency-Key (string) data: { . amount . deliveryMethods (array) . paymentData (string) . pspReference (string) . sessionId (string) . taxTotal } (object) required
checkout_service/post_sessions	Idempotency-Key (string) data: { . accountInfo . additionalAmount . additionalData (object) . allowedPaymentMethods (array) . amount . applicationInfo . authenticationData . billingAddress . blockedPaymentMethods (array) . captureDelayHours (integer) . channel (string) . company . countryCode (string) . dateOfBirth (string) . deliverAt (string) . deliveryAddress . enableOneClick (boolean) . enablePayOut (boolean) . enableRecurring (boolean) . expiresAt (string) . fundOrigin . fundRecipient . installmentOptions (object) . lineItems (array) . mandate . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . metadata (object) . mode (string) . mpiData . platformChargebackLogic . recurringExpiry (string) . recurringFrequency (string) . recurringProcessingModel (string) . redirectFromIssuerMethod (string) . redirectToIssuerMethod (string) . reference (string) . returnUrl (string) . riskData . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . showInstallmentAmount (boolean) . showRemovePaymentMethodButton (boolean) . socialSecurityNumber (string) . splitCardFundingSources (boolean) . splits (array) . store (string) . storeFiltrationMode (string) . storePaymentMethod (boolean) . storePaymentMethodMode (string) . telephoneNumber (string) . themeId (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) . trustedShopper (boolean) } (object) required
checkout_service/get_sessions_by_session_id	sessionId (string) sessionResult (string) required
checkout_service/get_stored_payment_methods	shopperReference (string) merchantAccount (string)
checkout_service/post_stored_payment_methods	Idempotency-Key (string) data: { . merchantAccount (string) . paymentMethod . recurringProcessingModel (string) . shopperEmail (string) . shopperIP (string) . shopperReference (string) } (object) required
checkout_service/delete_stored_payment_methods_by_stored_payment_method_id	storedPaymentMethodId (string) shopperReference (string) required merchantAccount (string) required
checkout_service/post_validate_shopper_id	data: { . merchantAccount (string) . paymentMethod . shopperEmail (string) . shopperIP (string) . shopperReference (string) } (object) required
cloud_device_service/get_merchants_by_merchant_account_connected_devices	merchantAccount (string) store (string)
cloud_device_service/post_merchants_by_merchant_account_devices_by_device_id_async	merchantAccount (string) deviceId (string) data (string) required
cloud_device_service/get_merchants_by_merchant_account_devices_by_device_id_status	merchantAccount (string) deviceId (string)
cloud_device_service/post_merchants_by_merchant_account_devices_by_device_id_sync	merchantAccount (string) deviceId (string) data (string) required
data_protection_service/post_request_subject_erasure	data: { . forceErasure (boolean) . merchantAccount (string) . pspReference (string) } (object) required
dispute_service/post_accept_dispute	data: { . disputePspReference (string) . merchantAccountCode (string) } (object) required
dispute_service/post_defend_dispute	data: { . defenseReasonCode (string) . disputePspReference (string) . merchantAccountCode (string) } (object) required
dispute_service/post_delete_dispute_defense_document	data: { . defenseDocumentType (string) . disputePspReference (string) . merchantAccountCode (string) } (object) required
dispute_service/post_retrieve_applicable_defense_reasons	data: { . disputePspReference (string) . merchantAccountCode (string) } (object) required
dispute_service/post_supply_defense_document	data: { . defenseDocuments (array) . disputePspReference (string) . merchantAccountCode (string) } (object) required
fund_service/post_account_holder_balance	data: { . accountHolderCode (string) } (object) required
fund_service/post_account_holder_transaction_list	data: { . accountHolderCode (string) . transactionListsPerAccount (array) . transactionStatuses (array) } (object) required
fund_service/post_debit_account_holder	data: { . accountHolderCode (string) . amount . bankAccountUUID (string) . description (string) . merchantAccount (string) . splits (array) } (object) required
fund_service/post_payout_account_holder	data: { . accountCode (string) . accountHolderCode (string) . amount . bankAccountUUID (string) . description (string) . merchantReference (string) . payoutMethodCode (string) . payoutSpeed (string) } (object) required
fund_service/post_refund_funds_transfer	data: { . amount . merchantReference (string) . originalReference (string) } (object) required
fund_service/post_refund_not_paid_out_transfers	data: { . accountCode (string) . accountHolderCode (string) } (object) required
fund_service/post_setup_beneficiary	data: { . destinationAccountCode (string) . merchantReference (string) . sourceAccountCode (string) } (object) required
fund_service/post_transfer_funds	data: { . amount . destinationAccountCode (string) . merchantReference (string) . sourceAccountCode (string) . transferCode (string) } (object) required
foreign_exchange_service/post_rates_calculate	data: { . exchangeCalculations (array) } (object) required
hop_service/post_get_onboarding_url	data: { . accountHolderCode (string) . collectInformation . editMode (boolean) . mobileOAuthCallbackUrl (string) . platformName (string) . returnUrl (string) . shopperLocale (string) . showPages } (object) required
hop_service/post_get_pci_questionnaire_url	data: { . accountHolderCode (string) . returnUrl (string) } (object) required
legal_entity_service/post_business_lines	data: { . industryCode (string) . legalEntityId (string) . salesChannels (array) . service (string) . sourceOfFunds . webData (array) . webDataExemption } (object) required
legal_entity_service/delete_business_lines_by_id	id (string)
legal_entity_service/get_business_lines_by_id	id (string)
legal_entity_service/patch_business_lines_by_id	id (string) data: { . industryCode (string) . salesChannels (array) . sourceOfFunds . webData (array) . webDataExemption } (object) required
legal_entity_service/post_documents	x-requested-verification-code (string) data: { . attachment . attachments (array) . creationDate (string) . description (string) . expiryDate (string) . fileName (string) . id (string) . issuerCountry (string) . issuerState (string) . modificationDate (string) . number (string) . owner . type (string) } (object) required
legal_entity_service/delete_documents_by_id	id (string)
legal_entity_service/get_documents_by_id	id (string) skipContent (boolean)
legal_entity_service/patch_documents_by_id	id (string) x-requested-verification-code (string) data: { . attachment . attachments (array) . creationDate (string) . description (string) . expiryDate (string) . fileName (string) . id (string) . issuerCountry (string) . issuerState (string) . modificationDate (string) . number (string) . owner . type (string) } (object) required
legal_entity_service/post_legal_entities	x-requested-verification-code (string) data: { . capabilities (object) . entityAssociations (array) . individual . organization . reference (string) . soleProprietorship . trust . type (string) . unincorporatedPartnership . verificationPlan (string) } (object) required
legal_entity_service/get_legal_entities_by_id	id (string)
legal_entity_service/patch_legal_entities_by_id	id (string) x-requested-verification-code (string) data: { . capabilities (object) . entityAssociations (array) . individual . organization . reference (string) . soleProprietorship . trust . type (string) . unincorporatedPartnership . verificationPlan (string) } (object) required
legal_entity_service/get_legal_entities_by_id_accepted_terms_of_service_document_by_termsofserviceacceptancereference	id (string) termsofserviceacceptancereference (string) termsOfServiceDocumentFormat (string)
legal_entity_service/get_legal_entities_by_id_business_lines	id (string)
legal_entity_service/post_legal_entities_by_id_check_tax_electronic_delivery_consent	id (string)
legal_entity_service/post_legal_entities_by_id_check_verification_errors	id (string)
legal_entity_service/post_legal_entities_by_id_confirm_data_review	id (string)
legal_entity_service/post_legal_entities_by_id_onboarding_links	id (string) data: { . locale (string) . redirectUrl (string) . settings . themeId (string) } (object) required
legal_entity_service/get_legal_entities_by_id_pci_questionnaires	id (string)
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_generate_pci_templates	id (string) data: { . additionalSalesChannels (array) . language (string) } (object) required
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_sign_pci_templates	id (string) data: { . pciTemplateReferences (array) . signedBy (string) } (object) required
legal_entity_service/post_legal_entities_by_id_pci_questionnaires_signing_required	id (string) data: { . additionalSalesChannels (array) } (object) required
legal_entity_service/get_legal_entities_by_id_pci_questionnaires_by_pciid	id (string) pciid (string)
legal_entity_service/post_legal_entities_by_id_set_tax_electronic_delivery_consent	id (string) data: { . US1099k (boolean) } (object) required
legal_entity_service/post_legal_entities_by_id_terms_of_service	id (string) data: { . language (string) . termsOfServiceDocumentFormat (string) . type (string) } (object) required
legal_entity_service/patch_legal_entities_by_id_terms_of_service_by_termsofservicedocumentid	id (string) termsofservicedocumentid (string) data: { . acceptedBy (string) . ipAddress (string) } (object) required
legal_entity_service/get_legal_entities_by_id_terms_of_service_acceptance_infos	id (string)
legal_entity_service/get_legal_entities_by_id_terms_of_service_status	id (string)
legal_entity_service/get_themes
legal_entity_service/get_themes_by_id	id (string)
legal_entity_service/post_transfer_instruments	x-requested-verification-code (string) data: { . bankAccount . legalEntityId (string) . type (string) } (object) required
legal_entity_service/delete_transfer_instruments_by_id	id (string)
legal_entity_service/get_transfer_instruments_by_id	id (string)
legal_entity_service/patch_transfer_instruments_by_id	id (string) x-requested-verification-code (string) data: { . bankAccount . legalEntityId (string) . type (string) } (object) required
management_service/get_companies	pageNumber (integer) pageSize (integer)
management_service/get_companies_by_company_id	companyId (string)
management_service/get_companies_by_company_id_android_apps	companyId (string) pageNumber (integer) pageSize (integer) packageName (string) versionCode (integer)
management_service/post_companies_by_company_id_android_apps	companyId (string)
management_service/get_companies_by_company_id_android_apps_by_id	companyId (string) id (string)
management_service/patch_companies_by_company_id_android_apps_by_id	companyId (string) id (string)
management_service/get_companies_by_company_id_android_certificates	companyId (string) pageNumber (integer) pageSize (integer) certificateName (string)
management_service/post_companies_by_company_id_android_certificates	companyId (string)
management_service/get_companies_by_company_id_api_credentials	companyId (string) pageNumber (integer) pageSize (integer)
management_service/post_companies_by_company_id_api_credentials	companyId (string) data: { . allowedOrigins (array) . associatedMerchantAccounts (array) . description (string) . roles (array) } (object) required
management_service/get_companies_by_company_id_api_credentials_by_api_credential_id	companyId (string) apiCredentialId (string)
management_service/patch_companies_by_company_id_api_credentials_by_api_credential_id	companyId (string) apiCredentialId (string) data: { . active (boolean) . allowedOrigins (array) . associatedMerchantAccounts (array) . description (string) . roles (array) } (object) required
management_service/get_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins	companyId (string) apiCredentialId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins	companyId (string) apiCredentialId (string) data: { . _links . domain (string) . id (string) } (object) required
management_service/delete_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_id	companyId (string) apiCredentialId (string) originId (string)
management_service/get_companies_by_company_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_id	companyId (string) apiCredentialId (string) originId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_generate_api_key	companyId (string) apiCredentialId (string)
management_service/post_companies_by_company_id_api_credentials_by_api_credential_id_generate_client_key	companyId (string) apiCredentialId (string)
management_service/get_companies_by_company_id_billing_entities	companyId (string) name (string)
management_service/get_companies_by_company_id_merchants	companyId (string) pageNumber (integer) pageSize (integer)
management_service/get_companies_by_company_id_shipping_locations	companyId (string) name (string) offset (integer) limit (integer)
management_service/post_companies_by_company_id_shipping_locations	companyId (string) data: { . address . contact . id (string) . name (string) } (object) required
management_service/get_companies_by_company_id_terminal_actions	companyId (string) pageNumber (integer) pageSize (integer) status (string) type (string)
management_service/get_companies_by_company_id_terminal_actions_by_action_id	companyId (string) actionId (string)
management_service/get_companies_by_company_id_terminal_logos	companyId (string) model (string) required
management_service/patch_companies_by_company_id_terminal_logos	companyId (string) model (string) required data: { . data (string) } (object) required
management_service/get_companies_by_company_id_terminal_models	companyId (string)
management_service/get_companies_by_company_id_terminal_orders	companyId (string) customerOrderReference (string) status (string) offset (integer) limit (integer)
management_service/post_companies_by_company_id_terminal_orders	companyId (string) data: { . billingEntityId (string) . customerOrderReference (string) . items (array) . orderType (string) . shippingLocationId (string) . taxId (string) } (object) required
management_service/get_companies_by_company_id_terminal_orders_by_order_id	companyId (string) orderId (string)
management_service/patch_companies_by_company_id_terminal_orders_by_order_id	companyId (string) orderId (string) data: { . billingEntityId (string) . customerOrderReference (string) . items (array) . orderType (string) . shippingLocationId (string) . taxId (string) } (object) required
management_service/post_companies_by_company_id_terminal_orders_by_order_id_cancel	companyId (string) orderId (string)
management_service/get_companies_by_company_id_terminal_products	companyId (string) country (string) required terminalModelId (string) offset (integer) limit (integer)
management_service/get_companies_by_company_id_terminal_settings	companyId (string)
management_service/patch_companies_by_company_id_terminal_settings	companyId (string) data: { . cardholderReceipt . connectivity . gratuities (array) . hardware . localization . nexo . offlineProcessing . opi . passcodes . payAtTable . payment . receiptOptions . receiptPrinting . refunds . signature . standalone . storeAndForward . surcharge . tapToPay . terminalInstructions . timeouts . wifiProfiles } (object) required
management_service/get_companies_by_company_id_users	companyId (string) pageNumber (integer) pageSize (integer) username (string)
management_service/post_companies_by_company_id_users	companyId (string) data: { . accountGroups (array) . associatedMerchantAccounts (array) . email (string) . loginMethod (string) . name . roles (array) . timeZoneCode (string) . username (string) } (object) required
management_service/get_companies_by_company_id_users_by_user_id	companyId (string) userId (string)
management_service/patch_companies_by_company_id_users_by_user_id	companyId (string) userId (string) data: { . accountGroups (array) . active (boolean) . associatedMerchantAccounts (array) . email (string) . loginMethod (string) . name . roles (array) . timeZoneCode (string) } (object) required
management_service/get_companies_by_company_id_webhooks	companyId (string) pageNumber (integer) pageSize (integer)
management_service/post_companies_by_company_id_webhooks	companyId (string) data: { . acceptsExpiredCertificate (boolean) . acceptsSelfSignedCertificate (boolean) . acceptsUntrustedRootCertificate (boolean) . active (boolean) . additionalSettings . communicationFormat (string) . description (string) . encryptionProtocol (string) . filterMerchantAccountType (string) . filterMerchantAccounts (array) . networkType (string) . password (string) . populateSoapActionHeader (boolean) . type (string) . url (string) . username (string) } (object) required
management_service/delete_companies_by_company_id_webhooks_by_webhook_id	companyId (string) webhookId (string)
management_service/get_companies_by_company_id_webhooks_by_webhook_id	companyId (string) webhookId (string)
management_service/patch_companies_by_company_id_webhooks_by_webhook_id	companyId (string) webhookId (string) data: { . acceptsExpiredCertificate (boolean) . acceptsSelfSignedCertificate (boolean) . acceptsUntrustedRootCertificate (boolean) . active (boolean) . additionalSettings . communicationFormat (string) . description (string) . encryptionProtocol (string) . filterMerchantAccountType (string) . filterMerchantAccounts (array) . networkType (string) . password (string) . populateSoapActionHeader (boolean) . url (string) . username (string) } (object) required
management_service/post_companies_by_company_id_webhooks_by_webhook_id_generate_hmac	companyId (string) webhookId (string)
management_service/post_companies_by_company_id_webhooks_by_webhook_id_test	companyId (string) webhookId (string) data: { . merchantIds (array) . notification . types (array) } (object) required
management_service/get_me
management_service/get_me_allowed_origins
management_service/post_me_allowed_origins	data: { . _links . domain (string) . id (string) } (object) required
management_service/delete_me_allowed_origins_by_origin_id	originId (string)
management_service/get_me_allowed_origins_by_origin_id	originId (string)
management_service/post_me_generate_client_key
management_service/get_merchants	pageNumber (integer) pageSize (integer)
management_service/post_merchants	data: { . businessLineId (string) . companyId (string) . description (string) . legalEntityId (string) . pricingPlan (string) . reference (string) . salesChannels (array) } (object) required
management_service/get_merchants_by_merchant_id	merchantId (string)
management_service/post_merchants_by_merchant_id_activate	merchantId (string)
management_service/get_merchants_by_merchant_id_api_credentials	merchantId (string) pageNumber (integer) pageSize (integer)
management_service/post_merchants_by_merchant_id_api_credentials	merchantId (string) data: { . allowedOrigins (array) . description (string) . roles (array) } (object) required
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_id	merchantId (string) apiCredentialId (string)
management_service/patch_merchants_by_merchant_id_api_credentials_by_api_credential_id	merchantId (string) apiCredentialId (string) data: { . active (boolean) . allowedOrigins (array) . description (string) . roles (array) } (object) required
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins	merchantId (string) apiCredentialId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins	merchantId (string) apiCredentialId (string) data: { . _links . domain (string) . id (string) } (object) required
management_service/delete_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_id	merchantId (string) apiCredentialId (string) originId (string)
management_service/get_merchants_by_merchant_id_api_credentials_by_api_credential_id_allowed_origins_by_origin_id	merchantId (string) apiCredentialId (string) originId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_generate_api_key	merchantId (string) apiCredentialId (string)
management_service/post_merchants_by_merchant_id_api_credentials_by_api_credential_id_generate_client_key	merchantId (string) apiCredentialId (string)
management_service/get_merchants_by_merchant_id_billing_entities	merchantId (string) name (string)
management_service/get_merchants_by_merchant_id_payment_method_settings	merchantId (string) storeId (string) businessLineId (string) pageSize (integer) pageNumber (integer)
management_service/post_merchants_by_merchant_id_payment_method_settings	merchantId (string) data: { . accel . affirm . afterpayTouch . alipayPlus . amex . applePay . bcmc . businessLineId (string) . cartesBancaires . clearpay . countries (array) . cup . currencies (array) . customRoutingFlags (array) . diners . discover . eft_directdebit_CA . eftpos_australia . girocard . googlePay . ideal . interac_card . jcb . klarna . maestro . maestro_usa . mc . mealVoucher_FR . nyce . paybybank_plaid . payme . paypal . payto . pulse . reference (string) . sepadirectdebit . shopperInteraction (string) . sodexo . sofort . star . storeIds (array) . swish . ticket . twint . type (string) . vipps . visa . wechatpay . wechatpay_pos } (object) required
management_service/get_merchants_by_merchant_id_payment_method_settings_by_payment_method_id	merchantId (string) paymentMethodId (string)
management_service/patch_merchants_by_merchant_id_payment_method_settings_by_payment_method_id	merchantId (string) paymentMethodId (string) data: { . accel . bcmc . cartesBancaires . countries (array) . cup . currencies (array) . customRoutingFlags (array) . diners . discover . eft_directdebit_CA . eftpos_australia . enabled (boolean) . girocard . ideal . interac_card . jcb . maestro . maestro_usa . mc . nyce . paybybank_plaid . pulse . sepadirectdebit . star . storeId (string) . storeIds (array) . visa } (object) required
management_service/post_merchants_by_merchant_id_payment_method_settings_by_payment_method_id_add_apple_pay_domains	merchantId (string) paymentMethodId (string) data: { . domains (array) } (object) required
management_service/get_merchants_by_merchant_id_payment_method_settings_by_payment_method_id_get_apple_pay_domains	merchantId (string) paymentMethodId (string)
management_service/get_merchants_by_merchant_id_payout_settings	merchantId (string)
management_service/post_merchants_by_merchant_id_payout_settings	merchantId (string) data: { . enabled (boolean) . enabledFromDate (string) . transferInstrumentId (string) } (object) required
management_service/delete_merchants_by_merchant_id_payout_settings_by_payout_settings_id	merchantId (string) payoutSettingsId (string)
management_service/get_merchants_by_merchant_id_payout_settings_by_payout_settings_id	merchantId (string) payoutSettingsId (string)
management_service/patch_merchants_by_merchant_id_payout_settings_by_payout_settings_id	merchantId (string) payoutSettingsId (string) data: { . enabled (boolean) } (object) required
management_service/get_merchants_by_merchant_id_shipping_locations	merchantId (string) name (string) offset (integer) limit (integer)
management_service/post_merchants_by_merchant_id_shipping_locations	merchantId (string) data: { . address . contact . id (string) . name (string) } (object) required
management_service/get_merchants_by_merchant_id_split_configurations	merchantId (string)
management_service/post_merchants_by_merchant_id_split_configurations	merchantId (string) data: { . description (string) . rules (array) . splitConfigurationId (string) } (object) required
management_service/delete_merchants_by_merchant_id_split_configurations_by_split_configuration_id	merchantId (string) splitConfigurationId (string)
management_service/get_merchants_by_merchant_id_split_configurations_by_split_configuration_id	merchantId (string) splitConfigurationId (string)
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_id	merchantId (string) splitConfigurationId (string) data: { . description (string) } (object) required
management_service/post_merchants_by_merchant_id_split_configurations_by_split_configuration_id	merchantId (string) splitConfigurationId (string) data: { . currency (string) . fundingSource (string) . paymentMethod (string) . ruleId (string) . shopperInteraction (string) . splitLogic } (object) required
management_service/delete_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_id	merchantId (string) splitConfigurationId (string) ruleId (string)
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_id	merchantId (string) splitConfigurationId (string) ruleId (string) data: { . currency (string) . fundingSource (string) . paymentMethod (string) . shopperInteraction (string) } (object) required
management_service/patch_merchants_by_merchant_id_split_configurations_by_split_configuration_id_rules_by_rule_id_split_logic_by_split_logic_id	merchantId (string) splitConfigurationId (string) ruleId (string) splitLogicId (string) data: { . acquiringFees (string) . additionalCommission . adyenCommission (string) . adyenFees (string) . adyenMarkup (string) . chargeback (string) . chargebackCostAllocation (string) . commission . interchange (string) . paymentFee (string) . refund (string) . refundCostAllocation (string) . remainder (string) . schemeFee (string) . splitLogicId (string) . surcharge (string) . tip (string) } (object) required
management_service/get_merchants_by_merchant_id_stores	merchantId (string) pageNumber (integer) pageSize (integer) reference (string)
management_service/post_merchants_by_merchant_id_stores	merchantId (string) data: { . address . businessLineIds (array) . description (string) . externalReferenceId (string) . phoneNumber (string) . reference (string) . shopperStatement (string) . splitConfiguration . subMerchantData } (object) required
management_service/get_merchants_by_merchant_id_stores_by_reference_terminal_logos	merchantId (string) reference (string) model (string) required
management_service/patch_merchants_by_merchant_id_stores_by_reference_terminal_logos	merchantId (string) reference (string) model (string) required data: { . data (string) } (object) required
management_service/get_merchants_by_merchant_id_stores_by_reference_terminal_settings	merchantId (string) reference (string)
management_service/patch_merchants_by_merchant_id_stores_by_reference_terminal_settings	merchantId (string) reference (string) data: { . cardholderReceipt . connectivity . gratuities (array) . hardware . localization . nexo . offlineProcessing . opi . passcodes . payAtTable . payment . receiptOptions . receiptPrinting . refunds . signature . standalone . storeAndForward . surcharge . tapToPay . terminalInstructions . timeouts . wifiProfiles } (object) required
management_service/get_merchants_by_merchant_id_stores_by_store_id	merchantId (string) storeId (string)
management_service/patch_merchants_by_merchant_id_stores_by_store_id	merchantId (string) storeId (string) data: { . address . businessLineIds (array) . description (string) . externalReferenceId (string) . phoneNumber (string) . splitConfiguration . status (string) . subMerchantData } (object) required
management_service/get_merchants_by_merchant_id_terminal_logos	merchantId (string) model (string) required
management_service/patch_merchants_by_merchant_id_terminal_logos	merchantId (string) model (string) required data: { . data (string) } (object) required
management_service/get_merchants_by_merchant_id_terminal_models	merchantId (string)
management_service/get_merchants_by_merchant_id_terminal_orders	merchantId (string) customerOrderReference (string) status (string) offset (integer) limit (integer)
management_service/post_merchants_by_merchant_id_terminal_orders	merchantId (string) data: { . billingEntityId (string) . customerOrderReference (string) . items (array) . orderType (string) . shippingLocationId (string) . taxId (string) } (object) required
management_service/get_merchants_by_merchant_id_terminal_orders_by_order_id	merchantId (string) orderId (string)
management_service/patch_merchants_by_merchant_id_terminal_orders_by_order_id	merchantId (string) orderId (string) data: { . billingEntityId (string) . customerOrderReference (string) . items (array) . orderType (string) . shippingLocationId (string) . taxId (string) } (object) required
management_service/post_merchants_by_merchant_id_terminal_orders_by_order_id_cancel	merchantId (string) orderId (string)
management_service/get_merchants_by_merchant_id_terminal_products	merchantId (string) country (string) required terminalModelId (string) offset (integer) limit (integer)
management_service/get_merchants_by_merchant_id_terminal_settings	merchantId (string)
management_service/patch_merchants_by_merchant_id_terminal_settings	merchantId (string) data: { . cardholderReceipt . connectivity . gratuities (array) . hardware . localization . nexo . offlineProcessing . opi . passcodes . payAtTable . payment . receiptOptions . receiptPrinting . refunds . signature . standalone . storeAndForward . surcharge . tapToPay . terminalInstructions . timeouts . wifiProfiles } (object) required
management_service/get_merchants_by_merchant_id_users	merchantId (string) pageNumber (integer) pageSize (integer) username (string)
management_service/post_merchants_by_merchant_id_users	merchantId (string) data: { . accountGroups (array) . email (string) . loginMethod (string) . name . roles (array) . timeZoneCode (string) . username (string) } (object) required
management_service/get_merchants_by_merchant_id_users_by_user_id	merchantId (string) userId (string)
management_service/patch_merchants_by_merchant_id_users_by_user_id	merchantId (string) userId (string) data: { . accountGroups (array) . active (boolean) . email (string) . loginMethod (string) . name . roles (array) . timeZoneCode (string) } (object) required
management_service/get_merchants_by_merchant_id_webhooks	merchantId (string) pageNumber (integer) pageSize (integer)
management_service/post_merchants_by_merchant_id_webhooks	merchantId (string) data: { . acceptsExpiredCertificate (boolean) . acceptsSelfSignedCertificate (boolean) . acceptsUntrustedRootCertificate (boolean) . active (boolean) . additionalSettings . communicationFormat (string) . description (string) . encryptionProtocol (string) . networkType (string) . password (string) . populateSoapActionHeader (boolean) . type (string) . url (string) . username (string) } (object) required
management_service/delete_merchants_by_merchant_id_webhooks_by_webhook_id	merchantId (string) webhookId (string)
management_service/get_merchants_by_merchant_id_webhooks_by_webhook_id	merchantId (string) webhookId (string)
management_service/patch_merchants_by_merchant_id_webhooks_by_webhook_id	merchantId (string) webhookId (string) data: { . acceptsExpiredCertificate (boolean) . acceptsSelfSignedCertificate (boolean) . acceptsUntrustedRootCertificate (boolean) . active (boolean) . additionalSettings . communicationFormat (string) . description (string) . encryptionProtocol (string) . networkType (string) . password (string) . populateSoapActionHeader (boolean) . url (string) . username (string) } (object) required
management_service/post_merchants_by_merchant_id_webhooks_by_webhook_id_generate_hmac	merchantId (string) webhookId (string)
management_service/post_merchants_by_merchant_id_webhooks_by_webhook_id_test	merchantId (string) webhookId (string) data: { . notification . types (array) } (object) required
management_service/get_stores	pageNumber (integer) pageSize (integer) reference (string) merchantId (string)
management_service/post_stores	data: { . address . businessLineIds (array) . description (string) . externalReferenceId (string) . merchantId (string) . phoneNumber (string) . reference (string) . shopperStatement (string) . splitConfiguration . subMerchantData } (object) required
management_service/get_stores_by_store_id	storeId (string)
management_service/patch_stores_by_store_id	storeId (string) data: { . address . businessLineIds (array) . description (string) . externalReferenceId (string) . phoneNumber (string) . splitConfiguration . status (string) . subMerchantData } (object) required
management_service/get_stores_by_store_id_terminal_logos	storeId (string) model (string) required
management_service/patch_stores_by_store_id_terminal_logos	storeId (string) model (string) required data: { . data (string) } (object) required
management_service/get_stores_by_store_id_terminal_settings	storeId (string)
management_service/patch_stores_by_store_id_terminal_settings	storeId (string) data: { . cardholderReceipt . connectivity . gratuities (array) . hardware . localization . nexo . offlineProcessing . opi . passcodes . payAtTable . payment . receiptOptions . receiptPrinting . refunds . signature . standalone . storeAndForward . surcharge . tapToPay . terminalInstructions . timeouts . wifiProfiles } (object) required
management_service/get_terminals	searchQuery (string) otpQuery (string) countries (string) merchantIds (string) storeIds (string) brandModels (string) pageNumber (integer) pageSize (integer)
management_service/post_terminals_schedule_actions	data: { . actionDetails . scheduledAt (string) . storeId (string) . terminalIds (array) } (object) required
management_service/post_terminals_by_terminal_id_reassign	terminalId (string) data: { . companyId (string) . inventory (boolean) . merchantId (string) . storeId (string) } (object) required
management_service/get_terminals_by_terminal_id_terminal_logos	terminalId (string)
management_service/patch_terminals_by_terminal_id_terminal_logos	terminalId (string) data: { . data (string) } (object) required
management_service/get_terminals_by_terminal_id_terminal_settings	terminalId (string)
management_service/patch_terminals_by_terminal_id_terminal_settings	terminalId (string) data: { . cardholderReceipt . connectivity . gratuities (array) . hardware . localization . nexo . offlineProcessing . opi . passcodes . payAtTable . payment . receiptOptions . receiptPrinting . refunds . signature . standalone . storeAndForward . surcharge . tapToPay . terminalInstructions . timeouts . wifiProfiles } (object) required
notification_configuration_service/post_create_notification_configuration	data: { . configurationDetails } (object) required
notification_configuration_service/post_delete_notification_configurations	data: { . notificationIds (array) } (object) required
notification_configuration_service/post_get_notification_configuration	data: { . notificationId (integer) } (object) required
notification_configuration_service/post_get_notification_configuration_list	data (object) required
notification_configuration_service/post_test_notification_configuration	data: { . eventTypes (array) . notificationId (integer) } (object) required
notification_configuration_service/post_update_notification_configuration	data: { . configurationDetails } (object) required
open_banking_service/post_account_verification_routes	data: { . country . locale (string) . redirectUrl (string) . state (string) } (object) required
open_banking_service/get_account_verification_reports_by_code	code (string)
payment_service/post_adjust_authorisation	data: { . additionalData (object) . merchantAccount (string) . modificationAmount . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_authorise	data: { . accountInfo . additionalAmount . additionalData (object) . amount . applicationInfo . bankAccount . billingAddress . browserInfo . captureDelayHours (integer) . card . dateOfBirth (string) . dccQuote . deliveryAddress . deliveryDate (string) . deviceFingerprint (string) . entityType (string) . fraudOffset (integer) . fundDestination . fundSource . fundingSource (string) . installments . localizedShopperStatement (object) . mandate . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . merchantRiskIndicator . metadata (object) . mpiData . nationality (string) . orderReference (string) . platformChargebackLogic . recurring . recurringProcessingModel (string) . reference (string) . secureRemoteCommerceCheckoutData . selectedBrand (string) . selectedRecurringDetailReference (string) . sessionId (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . socialSecurityNumber (string) . splits (array) . store (string) . telephoneNumber (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) . totalsGroup (string) . trustedShopper (boolean) } (object) required
payment_service/post_authorise3d	data: { . accountInfo . additionalAmount . additionalData (object) . amount . applicationInfo . billingAddress . browserInfo . captureDelayHours (integer) . dateOfBirth (string) . dccQuote . deliveryAddress . deliveryDate (string) . deviceFingerprint (string) . fraudOffset (integer) . installments . localizedShopperStatement (object) . mcc (string) . md (string) . merchantAccount (string) . merchantOrderReference (string) . merchantRiskIndicator . metadata (object) . orderReference (string) . paResponse (string) . recurring . recurringProcessingModel (string) . reference (string) . selectedBrand (string) . selectedRecurringDetailReference (string) . sessionId (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . socialSecurityNumber (string) . splits (array) . store (string) . telephoneNumber (string) . threeDS2RequestData . threeDSAuthenticationOnly (boolean) . totalsGroup (string) . trustedShopper (boolean) } (object) required
payment_service/post_authorise3ds2	data: { . accountInfo . additionalAmount . additionalData (object) . amount . applicationInfo . billingAddress . browserInfo . captureDelayHours (integer) . dateOfBirth (string) . dccQuote . deliveryAddress . deliveryDate (string) . deviceFingerprint (string) . fraudOffset (integer) . installments . localizedShopperStatement (object) . mcc (string) . merchantAccount (string) . merchantOrderReference (string) . merchantRiskIndicator . metadata (object) . orderReference (string) . recurring . recurringProcessingModel (string) . reference (string) . selectedBrand (string) . selectedRecurringDetailReference (string) . sessionId (string) . shopperEmail (string) . shopperIP (string) . shopperInteraction (string) . shopperLocale (string) . shopperName . shopperReference (string) . shopperStatement (string) . socialSecurityNumber (string) . splits (array) . store (string) . telephoneNumber (string) . threeDS2RequestData . threeDS2Result . threeDS2Token (string) . threeDSAuthenticationOnly (boolean) . totalsGroup (string) . trustedShopper (boolean) } (object) required
payment_service/post_cancel	data: { . additionalData (object) . merchantAccount (string) . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_cancel_or_refund	data: { . additionalData (object) . merchantAccount (string) . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_capture	data: { . additionalData (object) . merchantAccount (string) . modificationAmount . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_donate	data: { . donationAccount (string) . merchantAccount (string) . modificationAmount . originalReference (string) . platformChargebackLogic . reference (string) } (object) required
payment_service/post_get_authentication_result	data: { . merchantAccount (string) . pspReference (string) } (object) required
payment_service/post_refund	data: { . additionalData (object) . merchantAccount (string) . modificationAmount . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_retrieve3ds2_result	data: { . merchantAccount (string) . pspReference (string) } (object) required
payment_service/post_technical_cancel	data: { . additionalData (object) . merchantAccount (string) . modificationAmount . mpiData . originalMerchantReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payment_service/post_void_pending_refund	data: { . additionalData (object) . merchantAccount (string) . modificationAmount . mpiData . originalMerchantReference (string) . originalReference (string) . platformChargebackLogic . reference (string) . splits (array) . tenderReference (string) . uniqueTerminalId (string) } (object) required
payments_app_service/post_merchants_by_merchant_id_generate_payments_app_boarding_token	merchantId (string) data: { . boardingRequestToken (string) } (object) required
payments_app_service/post_merchants_by_merchant_id_stores_by_store_id_generate_payments_app_boarding_token	merchantId (string) storeId (string) data: { . boardingRequestToken (string) } (object) required
payments_app_service/get_merchants_by_merchant_id_payments_apps	merchantId (string) statuses (string) limit (integer) offset (integer)
payments_app_service/get_merchants_by_merchant_id_stores_by_store_id_payments_apps	merchantId (string) storeId (string) statuses (string) limit (integer) offset (integer)
payments_app_service/post_merchants_by_merchant_id_payments_apps_by_installation_id_revoke	merchantId (string) installationId (string)
recurring_service/post_create_permit	data: { . merchantAccount (string) . permits (array) . recurringDetailReference (string) . shopperReference (string) } (object) required
recurring_service/post_disable	data: { . contract (string) . merchantAccount (string) . recurringDetailReference (string) . shopperReference (string) } (object) required
recurring_service/post_disable_permit	data: { . merchantAccount (string) . token (string) } (object) required
recurring_service/post_list_recurring_details	data: { . merchantAccount (string) . recurring . shopperReference (string) } (object) required
recurring_service/post_notify_shopper	data: { . amount . billingDate (string) . billingSequenceNumber (string) . displayedReference (string) . merchantAccount (string) . recurringDetailReference (string) . reference (string) . shopperReference (string) . storedPaymentMethodId (string) } (object) required
recurring_service/post_schedule_account_updater	data: { . additionalData (object) . card . merchantAccount (string) . reference (string) . selectedRecurringDetailReference (string) . shopperReference (string) } (object) required
session_authentication_service/post_sessions	data: { . allowOrigin (string) . policy . product } (object) required
session_service/post_sessions	data: { . merchantAccount (string) . setupToken (string) . store (string) } (object) required
stored_value_service/post_change_status	data: { . amount . merchantAccount (string) . paymentMethod (object) . recurringDetailReference (string) . reference (string) . shopperInteraction (string) . shopperReference (string) . status (string) . store (string) } (object) required
stored_value_service/post_check_balance	data: { . amount . merchantAccount (string) . paymentMethod (object) . recurringDetailReference (string) . reference (string) . shopperInteraction (string) . shopperReference (string) . store (string) } (object) required
stored_value_service/post_issue	data: { . amount . merchantAccount (string) . paymentMethod (object) . recurringDetailReference (string) . reference (string) . shopperInteraction (string) . shopperReference (string) . store (string) } (object) required
stored_value_service/post_load	data: { . amount . loadType (string) . merchantAccount (string) . paymentMethod (object) . recurringDetailReference (string) . reference (string) . shopperInteraction (string) . shopperReference (string) . store (string) } (object) required
stored_value_service/post_merge_balance	data: { . amount . merchantAccount (string) . paymentMethod (object) . recurringDetailReference (string) . reference (string) . shopperInteraction (string) . shopperReference (string) . sourcePaymentMethod (object) . store (string) } (object) required
stored_value_service/post_void_transaction	data: { . merchantAccount (string) . originalReference (string) . reference (string) . store (string) . tenderReference (string) . uniqueTerminalId (string) } (object) required
terminal_api/post_login	data: { . DateTime (string) . SaleSoftware . SaleTerminalData . TrainingModeFlag (boolean) . OperatorLanguage (string) . OperatorID (string) . ShiftNumber (string) . TokenRequestedType . CustomerOrderReq . POISerialNumber (string) } (object) required
terminal_api/post_logout	data: { . MaintenanceAllowed (boolean) } (object) required
terminal_api/post_enableservice	data: { . TransactionAction . ServicesEnabled . DisplayOutput } (object) required
terminal_api/post_admin	data: { . ServiceIdentification (string) } (object) required
terminal_api/post_payment	data: { . SaleData . PaymentTransaction . PaymentData . LoyaltyData (array) } (object) required
terminal_api/post_cardacquisition	data: { . SaleData . CardAcquisitionTransaction } (object) required
terminal_api/post_storedvalue	data: { . SaleData . StoredValueData (array) } (object) required
terminal_api/post_reversal	data: { . SaleData . OriginalPOITransaction . ReversedAmount (number) . ReversalReason } (object) required
terminal_api/post_reconciliation	data: { . ReconciliationType . AcquirerID (array) . POIReconciliationID (integer) } (object) required
terminal_api/post_gettotals	data: { . TotalDetails . TotalFilter } (object) required
terminal_api/post_balanceinquiry	data: { . PaymentAccountReq . LoyaltyAccountReq } (object) required
terminal_api/post_transactionstatus	data: { . MessageReference . ReceiptReprintFlag (boolean) . DocumentQualifier (array) } (object) required
terminal_api/post_abort	data: { . MessageReference . AbortReason (string) . DisplayOutput } (object) required
terminal_api/post_diagnosis	data: { . POIID (string) . HostDiagnosisFlag (boolean) . AcquirerID (array) } (object) required
terminal_api/post_display	data: { . DisplayOutput (array) } (object) required
terminal_api/post_input	data: { . DisplayOutput . InputData } (object) required
terminal_api/post_print	data: { . PrintOutput } (object) required
terminal_api/post_cardreaderapdu	data: { . APDUClass (string) . APDUInstruction (string) . APDUPar1 (string) . APDUPar2 (string) . APDUData (string) . APDUExpectedLength (string) } (object) required
test_card_service/post_create_test_card_ranges	data (undefined) required
tfm_api_service/post_assign_terminals	data: { . companyAccount (string) . merchantAccount (string) . merchantInventory (boolean) . store (string) . terminals (array) } (object) required
tfm_api_service/post_find_terminal	data: { . terminal (string) } (object) required
tfm_api_service/post_get_stores_under_account	data: { . companyAccount (string) . merchantAccount (string) } (object) required
tfm_api_service/post_get_terminal_details	data: { . terminal (string) } (object) required
tfm_api_service/post_get_terminals_under_account	data: { . companyAccount (string) . merchantAccount (string) . store (string) } (object) required
transaction_service/get_disputes_by_dispute_id_attachments	disputeId (string)
transaction_service/post_disputes_by_dispute_id_attachments	disputeId (string) data: { . attachmentType . content (string) . fileName (string) . id (string) } (object) required
transaction_service/get_disputes_by_dispute_id_attachments_by_attachment_id	disputeId (string) attachmentId (string)
transaction_service/delete_disputes_by_dispute_id_attachments_by_attachment_id	disputeId (string) attachmentId (string)
transaction_service/get_disputes	status (string) paymentInstrument (string) createdSince (string) createdUntil (string) offset (string) limit (string)
transaction_service/post_disputes	data: { . description (string) . disputedAmount . duplicateInfo . fraudInfo . notDeliveredInfo . otherInfo . status . transactionId (string) . type } (object) required
transaction_service/get_disputes_by_id	id (string)
transaction_service/patch_disputes_by_id	id (string) data: { . duplicateInfo (object) . fraudInfo (object) . notDeliveredInfo (object) . otherInfo (object) . status (object) } (object) required
transfer_service/get_grants	counterpartyAccountHolderId (string)
transfer_service/post_grants	Idempotency-Key (string) data: { . counterparty . grantAccountId (string) . grantOfferId (string) } (object) required
transfer_service/get_grants_by_id	id (string)
transfer_service/get_transactions	balancePlatform (string) paymentInstrumentId (string) accountHolderId (string) balanceAccountId (string) cursor (string) createdSince (string) required createdUntil (string) required sortOrder (string) limit (integer)
transfer_service/get_transactions_by_id	id (string)
transfer_service/get_transfers	balancePlatform (string) accountHolderId (string) balanceAccountId (string) paymentInstrumentId (string) reference (string) category (string) createdSince (string) required createdUntil (string) required sortOrder (string) cursor (string) limit (integer)
transfer_service/post_transfers	Idempotency-Key (string) WWW-Authenticate (string) data: { . amount . balanceAccountId (string) . category (string) . counterparty . description (string) . executionDate . paymentInstrumentId (string) . priorities (array) . priority (string) . reference (string) . referenceForBeneficiary (string) . review . type (string) . ultimateParty } (object) required
transfer_service/post_transfers_approve	Idempotency-Key (string) WWW-Authenticate (string) data: { . transferIds (array) } (object) required
transfer_service/post_transfers_cancel	Idempotency-Key (string) data: { . transferIds (array) } (object) required
transfer_service/get_transfers_by_id	id (string)
transfer_service/post_transfers_by_transfer_id_returns	transferId (string) Idempotency-Key (string) data: { . amount . reference (string) } (object) required