Skip to content

Latest commit

 

History

History
1817 lines (1513 loc) · 136 KB

README.md

File metadata and controls

1817 lines (1513 loc) · 136 KB
Raw

Kotlin Multiplatform client library for Adyen's API

A kotlin multiplatform library for Adyen's api generated with openapi-generator based on the "multiplatform" target.

To regenerate, call:

make models

Missing Crypto for Terminals

Note, this library is missing the crypto need for api calls to terminals.

See: https://github.com/Adyen/adyen-java-api-library/blob/main/src/main/java/com/adyen/terminal/security/NexoCrypto.java

This still needs to be implemented.

com.adyen.client - Kotlin client library for Adyen Balance Control API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/BalanceControl/v1

Class Method HTTP request Description
GeneralApi postBalanceTransfer POST /balanceTransfer Start a balance transfer

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Configuration API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://balanceplatform-api-test.adyen.com/bcl/v2

Class Method HTTP request Description
AccountHoldersApi getAccountHoldersId GET /accountHolders/{id} Get an account holder
AccountHoldersApi getAccountHoldersIdBalanceAccounts GET /accountHolders/{id}/balanceAccounts Get all balance accounts of an account holder
AccountHoldersApi getAccountHoldersIdTaxForms GET /accountHolders/{id}/taxForms Get a tax form
AccountHoldersApi patchAccountHoldersId PATCH /accountHolders/{id} Update an account holder
AccountHoldersApi postAccountHolders POST /accountHolders Create an account holder
BalanceAccountsApi deleteBalanceAccountsBalanceAccountIdSweepsSweepId DELETE /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} Delete a sweep
BalanceAccountsApi getBalanceAccountsBalanceAccountIdSweeps GET /balanceAccounts/{balanceAccountId}/sweeps Get all sweeps for a balance account
BalanceAccountsApi getBalanceAccountsBalanceAccountIdSweepsSweepId GET /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} Get a sweep
BalanceAccountsApi getBalanceAccountsId GET /balanceAccounts/{id} Get a balance account
BalanceAccountsApi getBalanceAccountsIdPaymentInstruments GET /balanceAccounts/{id}/paymentInstruments Get all payment instruments for a balance account
BalanceAccountsApi patchBalanceAccountsBalanceAccountIdSweepsSweepId PATCH /balanceAccounts/{balanceAccountId}/sweeps/{sweepId} Update a sweep
BalanceAccountsApi patchBalanceAccountsId PATCH /balanceAccounts/{id} Update a balance account
BalanceAccountsApi postBalanceAccounts POST /balanceAccounts Create a balance account
BalanceAccountsApi postBalanceAccountsBalanceAccountIdSweeps POST /balanceAccounts/{balanceAccountId}/sweeps Create a sweep
BankAccountValidationApi postValidateBankAccountIdentification POST /validateBankAccountIdentification Validate a bank account
GrantAccountsApi getGrantAccountsId GET /grantAccounts/{id} Get a grant account
GrantOffersApi getGrantOffers GET /grantOffers Get all available grant offers
GrantOffersApi getGrantOffersGrantOfferId GET /grantOffers/{grantOfferId} Get a grant offer
NetworkTokensApi getNetworkTokensNetworkTokenId GET /networkTokens/{networkTokenId} Get a network token
NetworkTokensApi patchNetworkTokensNetworkTokenId PATCH /networkTokens/{networkTokenId} Update a network token
PaymentInstrumentGroupsApi getPaymentInstrumentGroupsId GET /paymentInstrumentGroups/{id} Get a payment instrument group
PaymentInstrumentGroupsApi getPaymentInstrumentGroupsIdTransactionRules GET /paymentInstrumentGroups/{id}/transactionRules Get all transaction rules for a payment instrument group
PaymentInstrumentGroupsApi postPaymentInstrumentGroups POST /paymentInstrumentGroups Create a payment instrument group
PaymentInstrumentsApi getPaymentInstrumentsId GET /paymentInstruments/{id} Get a payment instrument
PaymentInstrumentsApi getPaymentInstrumentsIdNetworkTokens GET /paymentInstruments/{id}/networkTokens List network tokens
PaymentInstrumentsApi getPaymentInstrumentsIdReveal GET /paymentInstruments/{id}/reveal Get the PAN of a payment instrument
PaymentInstrumentsApi getPaymentInstrumentsIdTransactionRules GET /paymentInstruments/{id}/transactionRules Get all transaction rules for a payment instrument
PaymentInstrumentsApi patchPaymentInstrumentsId PATCH /paymentInstruments/{id} Update a payment instrument
PaymentInstrumentsApi postPaymentInstruments POST /paymentInstruments Create a payment instrument
PlatformApi getBalancePlatformsId GET /balancePlatforms/{id} Get a balance platform
PlatformApi getBalancePlatformsIdAccountHolders GET /balancePlatforms/{id}/accountHolders Get all account holders under a balance platform
TransactionRulesApi deleteTransactionRulesTransactionRuleId DELETE /transactionRules/{transactionRuleId} Delete a transaction rule
TransactionRulesApi getTransactionRulesTransactionRuleId GET /transactionRules/{transactionRuleId} Get a transaction rule
TransactionRulesApi patchTransactionRulesTransactionRuleId PATCH /transactionRules/{transactionRuleId} Update a transaction rule
TransactionRulesApi postTransactionRules POST /transactionRules Create a transaction rule
TransferRoutesApi postTransferRoutesCalculate POST /transferRoutes/calculate Calculate transfer routes

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen BinLookup API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/BinLookup/v54

Class Method HTTP request Description
GeneralApi postGet3dsAvailability POST /get3dsAvailability Check if 3D Secure is available
GeneralApi postGetCostEstimate POST /getCostEstimate Get a fees cost estimate

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Checkout API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://checkout-test.adyen.com/v71

Class Method HTTP request Description
ClassicCheckoutSDKApi postPaymentSession POST /paymentSession Create a payment session
ClassicCheckoutSDKApi postPaymentsResult POST /payments/result Verify a payment result
ModificationsApi postCancels POST /cancels Cancel an authorised payment
ModificationsApi postPaymentsPaymentPspReferenceAmountUpdates POST /payments/{paymentPspReference}/amountUpdates Update an authorised amount
ModificationsApi postPaymentsPaymentPspReferenceCancels POST /payments/{paymentPspReference}/cancels Cancel an authorised payment
ModificationsApi postPaymentsPaymentPspReferenceCaptures POST /payments/{paymentPspReference}/captures Capture an authorised payment
ModificationsApi postPaymentsPaymentPspReferenceRefunds POST /payments/{paymentPspReference}/refunds Refund a captured payment
ModificationsApi postPaymentsPaymentPspReferenceReversals POST /payments/{paymentPspReference}/reversals Refund or cancel a payment
OrdersApi postOrders POST /orders Create an order
OrdersApi postOrdersCancel POST /orders/cancel Cancel an order
OrdersApi postPaymentMethodsBalance POST /paymentMethods/balance Get the balance of a gift card
PaymentLinksApi getPaymentLinksLinkId GET /paymentLinks/{linkId} Get a payment link
PaymentLinksApi patchPaymentLinksLinkId PATCH /paymentLinks/{linkId} Update the status of a payment link
PaymentLinksApi postPaymentLinks POST /paymentLinks Create a payment link
PaymentsApi getSessionsSessionId GET /sessions/{sessionId} Get the result of a payment session
PaymentsApi postCardDetails POST /cardDetails Get the list of brands on the card
PaymentsApi postDonations POST /donations Start a transaction for donations
PaymentsApi postPaymentMethods POST /paymentMethods Get a list of available payment methods
PaymentsApi postPayments POST /payments Start a transaction
PaymentsApi postPaymentsDetails POST /payments/details Submit details for a payment
PaymentsApi postSessions POST /sessions Create a payment session
RecurringApi deleteStoredPaymentMethodsStoredPaymentMethodId DELETE /storedPaymentMethods/{storedPaymentMethodId} Delete a token for stored payment details
RecurringApi getStoredPaymentMethods GET /storedPaymentMethods Get tokens for stored payment details
UtilityApi postApplePaySessions POST /applePay/sessions Get an Apple Pay session
UtilityApi postOriginKeys POST /originKeys Create originKey values for domains

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Data Protection API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://ca-test.adyen.com/ca/services/DataProtectionService/v1

Class Method HTTP request Description
GeneralApi postRequestSubjectErasure POST /requestSubjectErasure Submit a Subject Erasure Request.

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Legal Entity Management API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://kyc-test.adyen.com/lem/v3

Class Method HTTP request Description
BusinessLinesApi deleteBusinessLinesId DELETE /businessLines/{id} Delete a business line
BusinessLinesApi getBusinessLinesId GET /businessLines/{id} Get a business line
BusinessLinesApi patchBusinessLinesId PATCH /businessLines/{id} Update a business line
BusinessLinesApi postBusinessLines POST /businessLines Create a business line
DocumentsApi deleteDocumentsId DELETE /documents/{id} Delete a document
DocumentsApi getDocumentsId GET /documents/{id} Get a document
DocumentsApi patchDocumentsId PATCH /documents/{id} Update a document
DocumentsApi postDocuments POST /documents Upload a document for verification checks
HostedOnboardingApi getThemes GET /themes Get a list of hosted onboarding page themes
HostedOnboardingApi getThemesId GET /themes/{id} Get an onboarding link theme
HostedOnboardingApi postLegalEntitiesIdOnboardingLinks POST /legalEntities/{id}/onboardingLinks Get a link to an Adyen-hosted onboarding page
LegalEntitiesApi getLegalEntitiesId GET /legalEntities/{id} Get a legal entity
LegalEntitiesApi getLegalEntitiesIdBusinessLines GET /legalEntities/{id}/businessLines Get all business lines under a legal entity
LegalEntitiesApi patchLegalEntitiesId PATCH /legalEntities/{id} Update a legal entity
LegalEntitiesApi postLegalEntities POST /legalEntities Create a legal entity
LegalEntitiesApi postLegalEntitiesIdCheckVerificationErrors POST /legalEntities/{id}/checkVerificationErrors Check a legal entity's verification errors
LegalEntitiesApi postLegalEntitiesIdConfirmDataReview POST /legalEntities/{id}/confirmDataReview Confirm data review
PCIQuestionnairesApi getLegalEntitiesIdPciQuestionnaires GET /legalEntities/{id}/pciQuestionnaires Get PCI questionnaire details
PCIQuestionnairesApi getLegalEntitiesIdPciQuestionnairesPciid GET /legalEntities/{id}/pciQuestionnaires/{pciid} Get PCI questionnaire
PCIQuestionnairesApi postLegalEntitiesIdPciQuestionnairesGeneratePciTemplates POST /legalEntities/{id}/pciQuestionnaires/generatePciTemplates Generate PCI questionnaire
PCIQuestionnairesApi postLegalEntitiesIdPciQuestionnairesSignPciTemplates POST /legalEntities/{id}/pciQuestionnaires/signPciTemplates Sign PCI questionnaire
TermsOfServiceApi getLegalEntitiesIdTermsOfServiceAcceptanceInfos GET /legalEntities/{id}/termsOfServiceAcceptanceInfos Get Terms of Service information for a legal entity
TermsOfServiceApi getLegalEntitiesIdTermsOfServiceStatus GET /legalEntities/{id}/termsOfServiceStatus Get Terms of Service status
TermsOfServiceApi patchLegalEntitiesIdTermsOfServiceTermsofservicedocumentid PATCH /legalEntities/{id}/termsOfService/{termsofservicedocumentid} Accept Terms of Service
TermsOfServiceApi postLegalEntitiesIdTermsOfService POST /legalEntities/{id}/termsOfService Get Terms of Service document
TransferInstrumentsApi deleteTransferInstrumentsId DELETE /transferInstruments/{id} Delete a transfer instrument
TransferInstrumentsApi getTransferInstrumentsId GET /transferInstruments/{id} Get a transfer instrument
TransferInstrumentsApi patchTransferInstrumentsId PATCH /transferInstruments/{id} Update a transfer instrument
TransferInstrumentsApi postTransferInstruments POST /transferInstruments Create a transfer instrument

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Management API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://management-test.adyen.com/v3

Class Method HTTP request Description
APICredentialsCompanyLevelApi getCompaniesCompanyIdApiCredentials GET /companies/{companyId}/apiCredentials Get a list of API credentials
APICredentialsCompanyLevelApi getCompaniesCompanyIdApiCredentialsApiCredentialId GET /companies/{companyId}/apiCredentials/{apiCredentialId} Get an API credential
APICredentialsCompanyLevelApi patchCompaniesCompanyIdApiCredentialsApiCredentialId PATCH /companies/{companyId}/apiCredentials/{apiCredentialId} Update an API credential.
APICredentialsCompanyLevelApi postCompaniesCompanyIdApiCredentials POST /companies/{companyId}/apiCredentials Create an API credential.
APICredentialsMerchantLevelApi getMerchantsMerchantIdApiCredentials GET /merchants/{merchantId}/apiCredentials Get a list of API credentials
APICredentialsMerchantLevelApi getMerchantsMerchantIdApiCredentialsApiCredentialId GET /merchants/{merchantId}/apiCredentials/{apiCredentialId} Get an API credential
APICredentialsMerchantLevelApi patchMerchantsMerchantIdApiCredentialsApiCredentialId PATCH /merchants/{merchantId}/apiCredentials/{apiCredentialId} Update an API credential
APICredentialsMerchantLevelApi postMerchantsMerchantIdApiCredentials POST /merchants/{merchantId}/apiCredentials Create an API credential
APIKeyCompanyLevelApi postCompaniesCompanyIdApiCredentialsApiCredentialIdGenerateApiKey POST /companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey Generate new API key
APIKeyMerchantLevelApi postMerchantsMerchantIdApiCredentialsApiCredentialIdGenerateApiKey POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey Generate new API key
AccountCompanyLevelApi getCompanies GET /companies Get a list of company accounts
AccountCompanyLevelApi getCompaniesCompanyId GET /companies/{companyId} Get a company account
AccountCompanyLevelApi getCompaniesCompanyIdMerchants GET /companies/{companyId}/merchants Get a list of merchant accounts
AccountMerchantLevelApi getMerchants GET /merchants Get a list of merchant accounts
AccountMerchantLevelApi getMerchantsMerchantId GET /merchants/{merchantId} Get a merchant account
AccountMerchantLevelApi postMerchants POST /merchants Create a merchant account
AccountMerchantLevelApi postMerchantsMerchantIdActivate POST /merchants/{merchantId}/activate Request to activate a merchant account
AccountStoreLevelApi getMerchantsMerchantIdStores GET /merchants/{merchantId}/stores Get a list of stores
AccountStoreLevelApi getMerchantsMerchantIdStoresStoreId GET /merchants/{merchantId}/stores/{storeId} Get a store
AccountStoreLevelApi getStores GET /stores Get a list of stores
AccountStoreLevelApi getStoresStoreId GET /stores/{storeId} Get a store
AccountStoreLevelApi patchMerchantsMerchantIdStoresStoreId PATCH /merchants/{merchantId}/stores/{storeId} Update a store
AccountStoreLevelApi patchStoresStoreId PATCH /stores/{storeId} Update a store
AccountStoreLevelApi postMerchantsMerchantIdStores POST /merchants/{merchantId}/stores Create a store
AccountStoreLevelApi postStores POST /stores Create a store
AllowedOriginsCompanyLevelApi deleteCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOriginsOriginId DELETE /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Delete an allowed origin
AllowedOriginsCompanyLevelApi getCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOrigins GET /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins Get a list of allowed origins
AllowedOriginsCompanyLevelApi getCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOriginsOriginId GET /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Get an allowed origin
AllowedOriginsCompanyLevelApi postCompaniesCompanyIdApiCredentialsApiCredentialIdAllowedOrigins POST /companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins Create an allowed origin
AllowedOriginsMerchantLevelApi deleteMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOriginsOriginId DELETE /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Delete an allowed origin
AllowedOriginsMerchantLevelApi getMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOrigins GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins Get a list of allowed origins
AllowedOriginsMerchantLevelApi getMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOriginsOriginId GET /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId} Get an allowed origin
AllowedOriginsMerchantLevelApi postMerchantsMerchantIdApiCredentialsApiCredentialIdAllowedOrigins POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins Create an allowed origin
AndroidFilesCompanyLevelApi getCompaniesCompanyIdAndroidApps GET /companies/{companyId}/androidApps Get a list of Android apps
AndroidFilesCompanyLevelApi getCompaniesCompanyIdAndroidAppsId GET /companies/{companyId}/androidApps/{id} Get Android app
AndroidFilesCompanyLevelApi getCompaniesCompanyIdAndroidCertificates GET /companies/{companyId}/androidCertificates Get a list of Android certificates
AndroidFilesCompanyLevelApi postCompaniesCompanyIdAndroidApps POST /companies/{companyId}/androidApps Upload Android App
ClientKeyCompanyLevelApi postCompaniesCompanyIdApiCredentialsApiCredentialIdGenerateClientKey POST /companies/{companyId}/apiCredentials/{apiCredentialId}/generateClientKey Generate new client key
ClientKeyMerchantLevelApi postMerchantsMerchantIdApiCredentialsApiCredentialIdGenerateClientKey POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateClientKey Generate new client key
MyAPICredentialApi deleteMeAllowedOriginsOriginId DELETE /me/allowedOrigins/{originId} Remove allowed origin
MyAPICredentialApi getMe GET /me Get API credential details
MyAPICredentialApi getMeAllowedOrigins GET /me/allowedOrigins Get allowed origins
MyAPICredentialApi getMeAllowedOriginsOriginId GET /me/allowedOrigins/{originId} Get allowed origin details
MyAPICredentialApi postMeAllowedOrigins POST /me/allowedOrigins Add allowed origin
MyAPICredentialApi postMeGenerateClientKey POST /me/generateClientKey Generate a client key
PaymentMethodsMerchantLevelApi getMerchantsMerchantIdPaymentMethodSettings GET /merchants/{merchantId}/paymentMethodSettings Get all payment methods
PaymentMethodsMerchantLevelApi getMerchantsMerchantIdPaymentMethodSettingsPaymentMethodId GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} Get payment method details
PaymentMethodsMerchantLevelApi getMerchantsMerchantIdPaymentMethodSettingsPaymentMethodIdGetApplePayDomains GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/getApplePayDomains Get Apple Pay domains
PaymentMethodsMerchantLevelApi patchMerchantsMerchantIdPaymentMethodSettingsPaymentMethodId PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId} Update a payment method
PaymentMethodsMerchantLevelApi postMerchantsMerchantIdPaymentMethodSettings POST /merchants/{merchantId}/paymentMethodSettings Request a payment method
PaymentMethodsMerchantLevelApi postMerchantsMerchantIdPaymentMethodSettingsPaymentMethodIdAddApplePayDomains POST /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains Add an Apple Pay domain
PayoutSettingsMerchantLevelApi deleteMerchantsMerchantIdPayoutSettingsPayoutSettingsId DELETE /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Delete a payout setting
PayoutSettingsMerchantLevelApi getMerchantsMerchantIdPayoutSettings GET /merchants/{merchantId}/payoutSettings Get a list of payout settings
PayoutSettingsMerchantLevelApi getMerchantsMerchantIdPayoutSettingsPayoutSettingsId GET /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Get a payout setting
PayoutSettingsMerchantLevelApi patchMerchantsMerchantIdPayoutSettingsPayoutSettingsId PATCH /merchants/{merchantId}/payoutSettings/{payoutSettingsId} Update a payout setting
PayoutSettingsMerchantLevelApi postMerchantsMerchantIdPayoutSettings POST /merchants/{merchantId}/payoutSettings Add a payout setting
SplitConfigurationMerchantLevelApi deleteMerchantsMerchantIdSplitConfigurationsSplitConfigurationId DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Delete a split configuration
SplitConfigurationMerchantLevelApi deleteMerchantsMerchantIdSplitConfigurationsSplitConfigurationIdRulesRuleId DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} Delete a split configuration rule
SplitConfigurationMerchantLevelApi getMerchantsMerchantIdSplitConfigurations GET /merchants/{merchantId}/splitConfigurations Get a list of split configurations
SplitConfigurationMerchantLevelApi getMerchantsMerchantIdSplitConfigurationsSplitConfigurationId GET /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Get a split configuration
SplitConfigurationMerchantLevelApi patchMerchantsMerchantIdSplitConfigurationsSplitConfigurationId PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Update split configuration description
SplitConfigurationMerchantLevelApi patchMerchantsMerchantIdSplitConfigurationsSplitConfigurationIdRulesRuleId PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} Update split conditions
SplitConfigurationMerchantLevelApi patchMerchantsMerchantIdSplitConfigurationsSplitConfigurationIdRulesRuleIdSplitLogicSplitLogicId PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId} Update the split logic
SplitConfigurationMerchantLevelApi postMerchantsMerchantIdSplitConfigurations POST /merchants/{merchantId}/splitConfigurations Create a split configuration
SplitConfigurationMerchantLevelApi postMerchantsMerchantIdSplitConfigurationsSplitConfigurationId POST /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} Create a rule
TerminalActionsCompanyLevelApi getCompaniesCompanyIdTerminalActions GET /companies/{companyId}/terminalActions Get a list of terminal actions
TerminalActionsCompanyLevelApi getCompaniesCompanyIdTerminalActionsActionId GET /companies/{companyId}/terminalActions/{actionId} Get terminal action
TerminalActionsTerminalLevelApi postTerminalsScheduleActions POST /terminals/scheduleActions Create a terminal action
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdBillingEntities GET /companies/{companyId}/billingEntities Get a list of billing entities
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdShippingLocations GET /companies/{companyId}/shippingLocations Get a list of shipping locations
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdTerminalModels GET /companies/{companyId}/terminalModels Get a list of terminal models
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdTerminalOrders GET /companies/{companyId}/terminalOrders Get a list of orders
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdTerminalOrdersOrderId GET /companies/{companyId}/terminalOrders/{orderId} Get an order
TerminalOrdersCompanyLevelApi getCompaniesCompanyIdTerminalProducts GET /companies/{companyId}/terminalProducts Get a list of terminal products
TerminalOrdersCompanyLevelApi patchCompaniesCompanyIdTerminalOrdersOrderId PATCH /companies/{companyId}/terminalOrders/{orderId} Update an order
TerminalOrdersCompanyLevelApi postCompaniesCompanyIdShippingLocations POST /companies/{companyId}/shippingLocations Create a shipping location
TerminalOrdersCompanyLevelApi postCompaniesCompanyIdTerminalOrders POST /companies/{companyId}/terminalOrders Create an order
TerminalOrdersCompanyLevelApi postCompaniesCompanyIdTerminalOrdersOrderIdCancel POST /companies/{companyId}/terminalOrders/{orderId}/cancel Cancel an order
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdBillingEntities GET /merchants/{merchantId}/billingEntities Get a list of billing entities
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdShippingLocations GET /merchants/{merchantId}/shippingLocations Get a list of shipping locations
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdTerminalModels GET /merchants/{merchantId}/terminalModels Get a list of terminal models
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdTerminalOrders GET /merchants/{merchantId}/terminalOrders Get a list of orders
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdTerminalOrdersOrderId GET /merchants/{merchantId}/terminalOrders/{orderId} Get an order
TerminalOrdersMerchantLevelApi getMerchantsMerchantIdTerminalProducts GET /merchants/{merchantId}/terminalProducts Get a list of terminal products
TerminalOrdersMerchantLevelApi patchMerchantsMerchantIdTerminalOrdersOrderId PATCH /merchants/{merchantId}/terminalOrders/{orderId} Update an order
TerminalOrdersMerchantLevelApi postMerchantsMerchantIdShippingLocations POST /merchants/{merchantId}/shippingLocations Create a shipping location
TerminalOrdersMerchantLevelApi postMerchantsMerchantIdTerminalOrders POST /merchants/{merchantId}/terminalOrders Create an order
TerminalOrdersMerchantLevelApi postMerchantsMerchantIdTerminalOrdersOrderIdCancel POST /merchants/{merchantId}/terminalOrders/{orderId}/cancel Cancel an order
TerminalSettingsCompanyLevelApi getCompaniesCompanyIdTerminalLogos GET /companies/{companyId}/terminalLogos Get the terminal logo
TerminalSettingsCompanyLevelApi getCompaniesCompanyIdTerminalSettings GET /companies/{companyId}/terminalSettings Get terminal settings
TerminalSettingsCompanyLevelApi patchCompaniesCompanyIdTerminalLogos PATCH /companies/{companyId}/terminalLogos Update the terminal logo
TerminalSettingsCompanyLevelApi patchCompaniesCompanyIdTerminalSettings PATCH /companies/{companyId}/terminalSettings Update terminal settings
TerminalSettingsMerchantLevelApi getMerchantsMerchantIdTerminalLogos GET /merchants/{merchantId}/terminalLogos Get the terminal logo
TerminalSettingsMerchantLevelApi getMerchantsMerchantIdTerminalSettings GET /merchants/{merchantId}/terminalSettings Get terminal settings
TerminalSettingsMerchantLevelApi patchMerchantsMerchantIdTerminalLogos PATCH /merchants/{merchantId}/terminalLogos Update the terminal logo
TerminalSettingsMerchantLevelApi patchMerchantsMerchantIdTerminalSettings PATCH /merchants/{merchantId}/terminalSettings Update terminal settings
TerminalSettingsStoreLevelApi getMerchantsMerchantIdStoresReferenceTerminalLogos GET /merchants/{merchantId}/stores/{reference}/terminalLogos Get the terminal logo
TerminalSettingsStoreLevelApi getMerchantsMerchantIdStoresReferenceTerminalSettings GET /merchants/{merchantId}/stores/{reference}/terminalSettings Get terminal settings
TerminalSettingsStoreLevelApi getStoresStoreIdTerminalLogos GET /stores/{storeId}/terminalLogos Get the terminal logo
TerminalSettingsStoreLevelApi getStoresStoreIdTerminalSettings GET /stores/{storeId}/terminalSettings Get terminal settings
TerminalSettingsStoreLevelApi patchMerchantsMerchantIdStoresReferenceTerminalLogos PATCH /merchants/{merchantId}/stores/{reference}/terminalLogos Update the terminal logo
TerminalSettingsStoreLevelApi patchMerchantsMerchantIdStoresReferenceTerminalSettings PATCH /merchants/{merchantId}/stores/{reference}/terminalSettings Update terminal settings
TerminalSettingsStoreLevelApi patchStoresStoreIdTerminalLogos PATCH /stores/{storeId}/terminalLogos Update the terminal logo
TerminalSettingsStoreLevelApi patchStoresStoreIdTerminalSettings PATCH /stores/{storeId}/terminalSettings Update terminal settings
TerminalSettingsTerminalLevelApi getTerminalsTerminalIdTerminalLogos GET /terminals/{terminalId}/terminalLogos Get the terminal logo
TerminalSettingsTerminalLevelApi getTerminalsTerminalIdTerminalSettings GET /terminals/{terminalId}/terminalSettings Get terminal settings
TerminalSettingsTerminalLevelApi patchTerminalsTerminalIdTerminalLogos PATCH /terminals/{terminalId}/terminalLogos Update the logo
TerminalSettingsTerminalLevelApi patchTerminalsTerminalIdTerminalSettings PATCH /terminals/{terminalId}/terminalSettings Update terminal settings
TerminalsTerminalLevelApi getTerminals GET /terminals Get a list of terminals
TerminalsTerminalLevelApi postTerminalsTerminalIdReassign POST /terminals/{terminalId}/reassign Reassign a terminal
UsersCompanyLevelApi getCompaniesCompanyIdUsers GET /companies/{companyId}/users Get a list of users
UsersCompanyLevelApi getCompaniesCompanyIdUsersUserId GET /companies/{companyId}/users/{userId} Get user details
UsersCompanyLevelApi patchCompaniesCompanyIdUsersUserId PATCH /companies/{companyId}/users/{userId} Update user details
UsersCompanyLevelApi postCompaniesCompanyIdUsers POST /companies/{companyId}/users Create a new user
UsersMerchantLevelApi getMerchantsMerchantIdUsers GET /merchants/{merchantId}/users Get a list of users
UsersMerchantLevelApi getMerchantsMerchantIdUsersUserId GET /merchants/{merchantId}/users/{userId} Get user details
UsersMerchantLevelApi patchMerchantsMerchantIdUsersUserId PATCH /merchants/{merchantId}/users/{userId} Update a user
UsersMerchantLevelApi postMerchantsMerchantIdUsers POST /merchants/{merchantId}/users Create a new user
WebhooksCompanyLevelApi deleteCompaniesCompanyIdWebhooksWebhookId DELETE /companies/{companyId}/webhooks/{webhookId} Remove a webhook
WebhooksCompanyLevelApi getCompaniesCompanyIdWebhooks GET /companies/{companyId}/webhooks List all webhooks
WebhooksCompanyLevelApi getCompaniesCompanyIdWebhooksWebhookId GET /companies/{companyId}/webhooks/{webhookId} Get a webhook
WebhooksCompanyLevelApi patchCompaniesCompanyIdWebhooksWebhookId PATCH /companies/{companyId}/webhooks/{webhookId} Update a webhook
WebhooksCompanyLevelApi postCompaniesCompanyIdWebhooks POST /companies/{companyId}/webhooks Set up a webhook
WebhooksCompanyLevelApi postCompaniesCompanyIdWebhooksWebhookIdGenerateHmac POST /companies/{companyId}/webhooks/{webhookId}/generateHmac Generate an HMAC key
WebhooksCompanyLevelApi postCompaniesCompanyIdWebhooksWebhookIdTest POST /companies/{companyId}/webhooks/{webhookId}/test Test a webhook
WebhooksMerchantLevelApi deleteMerchantsMerchantIdWebhooksWebhookId DELETE /merchants/{merchantId}/webhooks/{webhookId} Remove a webhook
WebhooksMerchantLevelApi getMerchantsMerchantIdWebhooks GET /merchants/{merchantId}/webhooks List all webhooks
WebhooksMerchantLevelApi getMerchantsMerchantIdWebhooksWebhookId GET /merchants/{merchantId}/webhooks/{webhookId} Get a webhook
WebhooksMerchantLevelApi patchMerchantsMerchantIdWebhooksWebhookId PATCH /merchants/{merchantId}/webhooks/{webhookId} Update a webhook
WebhooksMerchantLevelApi postMerchantsMerchantIdWebhooks POST /merchants/{merchantId}/webhooks Set up a webhook
WebhooksMerchantLevelApi postMerchantsMerchantIdWebhooksWebhookIdGenerateHmac POST /merchants/{merchantId}/webhooks/{webhookId}/generateHmac Generate an HMAC key
WebhooksMerchantLevelApi postMerchantsMerchantIdWebhooksWebhookIdTest POST /merchants/{merchantId}/webhooks/{webhookId}/test Test a webhook

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Payment API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/Payment/v68

Class Method HTTP request Description
ModificationsApi postAdjustAuthorisation POST /adjustAuthorisation Change the authorised amount
ModificationsApi postCancel POST /cancel Cancel an authorisation
ModificationsApi postCancelOrRefund POST /cancelOrRefund Cancel or refund a payment
ModificationsApi postCapture POST /capture Capture an authorisation
ModificationsApi postDonate POST /donate Create a donation
ModificationsApi postRefund POST /refund Refund a captured payment
ModificationsApi postTechnicalCancel POST /technicalCancel Cancel an authorisation using your reference
ModificationsApi postVoidPendingRefund POST /voidPendingRefund Cancel an in-person refund
PaymentsApi postAuthorise POST /authorise Create an authorisation
PaymentsApi postAuthorise3d POST /authorise3d Complete a 3DS authorisation
PaymentsApi postAuthorise3ds2 POST /authorise3ds2 Complete a 3DS2 authorisation
PaymentsApi postGetAuthenticationResult POST /getAuthenticationResult Get the 3DS authentication result
PaymentsApi postRetrieve3ds2Result POST /retrieve3ds2Result Get the 3DS2 authentication result

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Payout API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/Payout/v68

Class Method HTTP request Description
InitializationApi postStoreDetail POST /storeDetail Store payout details
InitializationApi postStoreDetailAndSubmitThirdParty POST /storeDetailAndSubmitThirdParty Store details and submit a payout
InitializationApi postSubmitThirdParty POST /submitThirdParty Submit a payout
InstantPayoutsApi postPayout POST /payout Make an instant card payout
ReviewingApi postConfirmThirdParty POST /confirmThirdParty Confirm a payout
ReviewingApi postDeclineThirdParty POST /declineThirdParty Cancel a payout

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for POS Terminal Management API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://postfmapi-test.adyen.com/postfmapi/terminal/v1

Class Method HTTP request Description
GeneralApi postAssignTerminals POST /assignTerminals Assign terminals
GeneralApi postFindTerminal POST /findTerminal Get the account or store of a terminal
GeneralApi postGetStoresUnderAccount POST /getStoresUnderAccount Get the stores of an account
GeneralApi postGetTerminalDetails POST /getTerminalDetails Get the details of a terminal
GeneralApi postGetTerminalsUnderAccount POST /getTerminalsUnderAccount Get the list of terminals

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Recurring API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/Recurring/v68

Class Method HTTP request Description
GeneralApi postCreatePermit POST /createPermit Create new permits linked to a recurring contract.
GeneralApi postDisable POST /disable Disable stored payment details
GeneralApi postDisablePermit POST /disablePermit Disable an existing permit.
GeneralApi postListRecurringDetails POST /listRecurringDetails Get stored payment details
GeneralApi postNotifyShopper POST /notifyShopper Ask issuer to notify the shopper
GeneralApi postScheduleAccountUpdater POST /scheduleAccountUpdater Schedule running the Account Updater

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Transfers API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://balanceplatform-api-test.adyen.com/btl/v4

Class Method HTTP request Description
CapitalApi getGrants GET /grants Get a capital account
CapitalApi getGrantsId GET /grants/{id} Get grant reference details
CapitalApi postGrants POST /grants Request a grant payout
TransactionsApi getTransactions GET /transactions Get all transactions
TransactionsApi getTransactionsId GET /transactions/{id} Get a transaction
TransfersApi postTransfers POST /transfers Transfer funds
TransfersApi postTransfersIdReturns POST /transfers/{id}/returns Return a transfer

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Adyen Stored Value API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://pal-test.adyen.com/pal/servlet/StoredValue/v46

Class Method HTTP request Description
GeneralApi postChangeStatus POST /changeStatus Changes the status of the payment method.
GeneralApi postCheckBalance POST /checkBalance Checks the balance.
GeneralApi postIssue POST /issue Issues a new card.
GeneralApi postLoad POST /load Loads the payment method.
GeneralApi postMergeBalance POST /mergeBalance Merge the balance of two cards.
GeneralApi postVoidTransaction POST /voidTransaction Voids a transaction.

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

com.adyen.client - Kotlin client library for Disputes API

Requires

  • Kotlin 1.5.10

Build

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.

Documentation for API Endpoints

All URIs are relative to https://ca-test.adyen.com/ca/services/DisputeService/v30

Class Method HTTP request Description
GeneralApi postAcceptDispute POST /acceptDispute Accept a dispute
GeneralApi postDefendDispute POST /defendDispute Defend a dispute
GeneralApi postDeleteDisputeDefenseDocument POST /deleteDisputeDefenseDocument Delete a defense document
GeneralApi postRetrieveApplicableDefenseReasons POST /retrieveApplicableDefenseReasons Get applicable defense reasons
GeneralApi postSupplyDefenseDocument POST /supplyDefenseDocument Supply a defense document

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication