Qodex.ai
Qodex.ai
Introduction
Adyen Balance Control API (v1)
General-/balanceTransfer
Transfer balances between merchant accounts
Adyen BinLookup API (v54)
General-/get3dsAvailability
Get 3D Secure availability
General-/getCostEstimate
Estimate the transaction cost (recurring contract)
Adyen Checkout API (v71)
Modifications-/cancels
Cancel a payment using your own reference
Modifications-/payments/:paymentPspReference/amountUpdates
Update the amount of an authorised payment
Modifications-/payments/:paymentPspReference/cancels
Cancel payment using a PSP reference
Modifications-/payments/:paymentPspReference/captures
Capture an authorised payment
Modifications-/payments/:paymentPspReference/refunds
Refund a payment
Modifications-/payments/:paymentPspReference/reversals
Reverse (cancel or refund) a payment
Classic Checkout SDK-/paymentSession (DEPRECATED)
Set up a payment session (Web)
Classic Checkout SDK-/payments/result (DEPRECATED)
Verify payment results
Orders-/orders
Create an order
Orders-/orders/cancel
Cancel an order
Orders-/paymentMethods/balance
Get gift card balance specifying amount of 100 EUR
Utility-/applePay/sessions
Get payment session for Apple Pay
Utility-/originKeys (DEPRECATED)
Get origin keys
Utility-/paypal/updateOrder
Update a PayPal order in a Sessions flow integration
Recurring-/storedPaymentMethods
Get tokens for stored payment detailsStore encrypted card details for subscription payments
Recurring-/storedPaymentMethods/:storedPaymentMethodId
Delete a token for stored payment details
Donations-/donationCampaigns
Get a list of active donation campaigns
Donations-/donations
Start a donation transaction with a token
Payments-/cardDetails
Get a list of brands on a card specifying your supported card brands
Payments-/paymentMethods
Get payment methods including stored card details
Payments-/payments
Tokenize card details for a subscription
Payments-/payments/details
Submit 3D Secure 2 authentication result
Payments-/sessions
Split a payment between balance accounts
Payments-/sessions/:sessionId
Get the result of a payment session
Payment links-/paymentLinks
Create a payment link
Payment links-/paymentLinks/:linkId
Get a payment linkUpdate the status of a payment link
Adyen Data Protection API (v1)
General-/requestSubjectErasure
Submit a Subject Erasure Request.
Adyen Payout API (v68)
Initialization-/storeDetail
Store payout details
Initialization-/storeDetailAndSubmitThirdParty
Submit a payout to Skrill
Initialization-/submitThirdParty
Submit a payout
Instant payouts-/payout
Instant card payout (P2P)
Reviewing-/confirmThirdParty
Confirm a payout
Reviewing-/declineThirdParty
Cancel a payout
Adyen Recurring API (v68)
General-/createPermit
Create new permits linked to a recurring contract.
General-/disable
Disable a recurring contract
General-/disablePermit
Disable an existing permit.
General-/listRecurringDetails
List recurring details of the specified contract value
General-/notifyShopper
Request issuer to notify shopper of upcoming recurring payment
General-/scheduleAccountUpdater
Schedule AccountUpdater with token data
Adyen Stored Value API (v46)
General-/changeStatus
Changes the status of the payment method.
General-/checkBalance
Checks the balance.
General-/issue
Issues a new card.
General-/load
Loads the payment method.
General-/mergeBalance
Merge the balance of two cards.
General-/voidTransaction
Voids a transaction.
Adyen Test Cards API (v1)
General-/createTestCardRanges
Creates one or more test card ranges.
Configuration API (v2)
Platform-/balancePlatforms/:id
Get a balance platform
Platform-/balancePlatforms/:id/accountHolders
Get all account holders under a balance platform
Grant offers-/grantOffers
Get all available grant offers
Grant offers-/grantOffers/:grantOfferId
Get a grant offer
Network tokens-/networkTokens/:networkTokenId
Get a network tokenUpdate a network token
Account holders-/accountHolders
Create an account holder
Account holders-/accountHolders/:id
Get an account holderDeactivate an account holder
Account holders-/accountHolders/:id/balanceAccounts
Get all balance accounts of an account holder
Account holders-/accountHolders/:id/taxForms
Get a tax form
Payment instruments-/paymentInstruments
Create a virtual card
Payment instruments-/paymentInstruments/:id
Get a payment instrumentUpdate the status of a payment instrument
Payment instruments-/paymentInstruments/:id/networkTokens
List network tokens
Payment instruments-/paymentInstruments/:id/reveal
Get the PAN of a payment instrument
Payment instruments-/paymentInstruments/:id/transactionRules
Get all transaction rules for a payment instrument
Payment instruments-/paymentInstruments/reveal
Reveal the data of a payment instrument
Grant accounts-/grantAccounts/:id
Get a grant account
Balance accounts-/balanceAccounts
Create a balance account
Balance accounts-/balanceAccounts/:balanceAccountId/sweeps
Get all sweeps for a balance accountCreate a sweep to push funds out of a balance account with set priorities
Balance accounts-/balanceAccounts/:balanceAccountId/sweeps/:sweepId
Delete a sweepGet a sweepUpdate the status of a sweep
Balance accounts-/balanceAccounts/:id
Get a balance accountUpdate the time zone of a balance account
Balance accounts-/balanceAccounts/:id/paymentInstruments
Get payment instruments linked to a balance account
Transaction rules-/transactionRules
Limit international payments
Transaction rules-/transactionRules/:transactionRuleId
Delete a transaction ruleGet a transaction ruleUpdate the interval of transaction rule
Card orders-/cardorders
Get a list of card orders
Card orders-/cardorders/:id/items
Get card order items
Payment instrument groups-/paymentInstrumentGroups
Create a payment instrument group
Payment instrument groups-/paymentInstrumentGroups/:id
Get a payment instrument group
Payment instrument groups-/paymentInstrumentGroups/:id/transactionRules
Get all transaction rules for a payment instrument group
Bank account validation-/validateBankAccountIdentification
Validate a US bank account
Manage card PIN-/pins/change
Request a PIN change
Manage card PIN-/pins/reveal
Request a PIN block
Manage card PIN-/publicKey
Get an RSA public key
Transfer routes-/transferRoutes/calculate
Calculate transfer routes
Manage SCA devices-/registeredDevices
Get a list of registered SCA devicesInitiate the registration of an SCA device
Manage SCA devices-/registeredDevices/:id
Delete a registration of an SCA deviceComplete the registration of an SCA device
Disputes API (v30)
General-/acceptDispute
Accept a dispute
General-/defendDispute
Defend a dispute
General-/deleteDisputeDefenseDocument
Delete a dispute defense document
General-/retrieveApplicableDefenseReasons
Retrieve applicable defense reasons
General-/supplyDefenseDocument
Supply dispute defense documents
Legal Entity Management API (v3)
Legal entities-/legalEntities
Create a legal entity for a trust in Australia
Legal entities-/legalEntities/:id
Get a legal entityAssociate an exempt settlor with a trust
Legal entities-/legalEntities/:id/businessLines
Get all business lines under a legal entity
Legal entities-/legalEntities/:id/checkVerificationErrors
Check a legal entity's verification errors
Legal entities-/legalEntities/:id/confirmDataReview
Confirm data review
Hosted Onboarding-/legalEntities/:id/onboardingLinks
Create a hosted onboarding link
Hosted Onboarding-/themes
Get a list of hosted onboarding page themes
Hosted Onboarding-/themes/:id
Get an onboarding link theme
Business lines-/businessLines
Create a business line for receiving payments
Business lines-/businessLines/:id
Delete a business lineGet a business lineUpdate a business line
Documents-/documents
Upload a document
Documents-/documents/:id
Delete a documentGet a documentUpdate a document
Terms of Service-/legalEntities/:id/termsOfService
Get the Terms of Service document
Terms of Service-/legalEntities/:id/termsOfService/:termsofservicedocumentid
Accept the Terms of Service document
Terms of Service-/legalEntities/:id/termsOfServiceAcceptanceInfos
Get Terms of Service information for a legal entity
Terms of Service-/legalEntities/:id/termsOfServiceStatus
Get Terms of Service status
Transfer instruments-/transferInstruments
Add a USD bank account
Transfer instruments-/transferInstruments/:id
Delete a transfer instrumentGet a transfer instrumentUpdate a transfer instrument
PCI questionnaires-/legalEntities/:id/pciQuestionnaires
Get PCI questionnaire details
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/:pciid
Get PCI questionnaire
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/generatePciTemplates
Generate PCI questionnaires
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/signPciTemplates
Sign PCI questionnaires
Management API
API key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Account - merchant level-/merchants
Get a list of merchant accountsCreate a merchant account for an Adyen for Platforms Manage integration
Account - merchant level-/merchants/:merchantId
Get a merchant account
Account - merchant level-/merchants/:merchantId/activate
Request to activate a merchant account
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations
Get a list of split configurationsCreate a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId
Delete a split configurationGet a split configurationUpdate split configuration descriptionAdd rule to a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId
Delete a split configuration ruleUpdate the conditions in split configuration rule
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId
Update the split logic
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
API key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Client key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Users - company level-/companies/:companyId/users
Get a list of usersCreate a user
Users - company level-/companies/:companyId/users/:userId
Get user detailsUpdate user details
Terminal actions - terminal level-/terminals/scheduleActions
Invalid terminal ID in the request
Terminal settings - terminal level-/terminals/:terminalId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - terminal level-/terminals/:terminalId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Payout settings - merchant level-/merchants/:merchantId/payoutSettings
Get a list of payout settingsAdd a payout setting
Payout settings - merchant level-/merchants/:merchantId/payoutSettings/:payoutSettingsId
Delete a payout settingGet a payout settingUpdate a payout setting
Webhooks - merchant level-/merchants/:merchantId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/test
Test a webhook notification
Client key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
Terminal orders - company level-/companies/:companyId/billingEntities
Get a list of billing entities
Terminal orders - company level-/companies/:companyId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - company level-/companies/:companyId/terminalModels
Get a list of terminal models
Terminal orders - company level-/companies/:companyId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - company level-/companies/:companyId/terminalProducts
Get a list of terminal products
API credentials - merchant level-/merchants/:merchantId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Users - merchant level-/merchants/:merchantId/users
Get a list of usersCreate a user
Users - merchant level-/merchants/:merchantId/users/:userId
Get user detailsUpdate a user
Terminal actions - company level-/companies/:companyId/terminalActions
Get a list of terminal actions
Terminal actions - company level-/companies/:companyId/terminalActions/:actionId
Get terminal action
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings
Get all payment methodsRequest to add Swish
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId
Get payment method detailsUpdate a payment method
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains
Add an Apple Pay domain
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains
Get Apple Pay domains
My API credential-/me
Get API credential details
My API credential-/me/allowedOrigins
Get allowed originsAdd allowed origin
My API credential-/me/allowedOrigins/:originId
Remove allowed originGet allowed origin details
My API credential-/me/generateClientKey
Generate a client key
Terminal settings - merchant level-/merchants/:merchantId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - merchant level-/merchants/:merchantId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminals - terminal level-/terminals
Get a list of terminals
Terminals - terminal level-/terminals/:terminalId/reassign
Reassign a terminal
Webhooks - company level-/companies/:companyId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - company level-/companies/:companyId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/test
Test a webhook notification
Account - store level-/merchants/:merchantId/stores
Get a list of storesCreate a store under the merchant account specified in the path.
Account - store level-/merchants/:merchantId/stores/:storeId
Get a storeAdd split configuration to store
Account - store level-/stores
Get a list of storesCreate a store
Account - store level-/stores/:storeId
Get a storeAdd split configuration to store
Android files - company level-/companies/:companyId/androidApps
Get a list of Android appsUpload Android App
Android files - company level-/companies/:companyId/androidApps/:id
Get Android app
Android files - company level-/companies/:companyId/androidCertificates
Get a list of Android certificates
Terminal settings - company level-/companies/:companyId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - company level-/companies/:companyId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
API credentials - company level-/companies/:companyId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - company level-/companies/:companyId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Terminal orders - merchant level-/merchants/:merchantId/billingEntities
Get a list of billing entities
Terminal orders - merchant level-/merchants/:merchantId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - merchant level-/merchants/:merchantId/terminalModels
Get a list of terminal models
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - merchant level-/merchants/:merchantId/terminalProducts
Get a list of terminal products
Account - company level-/companies
Get a list of company accounts
Account - company level-/companies/:companyId
Get a company account
Account - company level-/companies/:companyId/merchants
Get a list of merchant accounts
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminal settings - store level-/stores/:storeId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/stores/:storeId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Management API (v3)
API key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Account - merchant level-/merchants
Get a list of merchant accountsCreate a merchant account for an Adyen for Platforms Manage integration
Account - merchant level-/merchants/:merchantId
Get a merchant account
Account - merchant level-/merchants/:merchantId/activate
Request to activate a merchant account
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations
Get a list of split configurationsCreate a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId
Delete a split configurationGet a split configurationUpdate split configuration descriptionAdd rule to a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId
Delete a split configuration ruleUpdate the conditions in split configuration rule
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId
Update the split logic
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
API key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Client key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Users - company level-/companies/:companyId/users
Get a list of usersCreate a user
Users - company level-/companies/:companyId/users/:userId
Get user detailsUpdate user details
Terminal actions - terminal level-/terminals/scheduleActions
Invalid terminal ID in the request
Terminal settings - terminal level-/terminals/:terminalId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - terminal level-/terminals/:terminalId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Payout settings - merchant level-/merchants/:merchantId/payoutSettings
Get a list of payout settingsAdd a payout setting
Payout settings - merchant level-/merchants/:merchantId/payoutSettings/:payoutSettingsId
Delete a payout settingGet a payout settingUpdate a payout setting
Webhooks - merchant level-/merchants/:merchantId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/test
Test a webhook notification
Client key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
Terminal orders - company level-/companies/:companyId/billingEntities
Get a list of billing entities
Terminal orders - company level-/companies/:companyId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - company level-/companies/:companyId/terminalModels
Get a list of terminal models
Terminal orders - company level-/companies/:companyId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - company level-/companies/:companyId/terminalProducts
Get a list of terminal products
API credentials - merchant level-/merchants/:merchantId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Users - merchant level-/merchants/:merchantId/users
Get a list of usersCreate a user
Users - merchant level-/merchants/:merchantId/users/:userId
Get user detailsUpdate a user
Terminal actions - company level-/companies/:companyId/terminalActions
Get a list of terminal actions
Terminal actions - company level-/companies/:companyId/terminalActions/:actionId
Get terminal action
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings
Get all payment methodsRequest to add Swish
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId
Get payment method detailsUpdate a payment method
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains
Add an Apple Pay domain
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains
Get Apple Pay domains
My API credential-/me
Get API credential details
My API credential-/me/allowedOrigins
Get allowed originsAdd allowed origin
My API credential-/me/allowedOrigins/:originId
Remove allowed originGet allowed origin details
My API credential-/me/generateClientKey
Generate a client key
Terminal settings - merchant level-/merchants/:merchantId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - merchant level-/merchants/:merchantId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminals - terminal level-/terminals
Get a list of terminals
Terminals - terminal level-/terminals/:terminalId/reassign
Reassign a terminal
Webhooks - company level-/companies/:companyId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - company level-/companies/:companyId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/test
Test a webhook notification
Account - store level-/merchants/:merchantId/stores
Get a list of storesCreate a store under the merchant account specified in the path.
Account - store level-/merchants/:merchantId/stores/:storeId
Get a storeAdd split configuration to store
Account - store level-/stores
Get a list of storesCreate a store
Account - store level-/stores/:storeId
Get a storeAdd split configuration to store
Android files - company level-/companies/:companyId/androidApps
Get a list of Android appsUpload Android App
Android files - company level-/companies/:companyId/androidApps/:id
Get Android app
Android files - company level-/companies/:companyId/androidCertificates
Get a list of Android certificates
Terminal settings - company level-/companies/:companyId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - company level-/companies/:companyId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
API credentials - company level-/companies/:companyId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - company level-/companies/:companyId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Terminal orders - merchant level-/merchants/:merchantId/billingEntities
Get a list of billing entities
Terminal orders - merchant level-/merchants/:merchantId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - merchant level-/merchants/:merchantId/terminalModels
Get a list of terminal models
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - merchant level-/merchants/:merchantId/terminalProducts
Get a list of terminal products
Account - company level-/companies
Get a list of company accounts
Account - company level-/companies/:companyId
Get a company account
Account - company level-/companies/:companyId/merchants
Get a list of merchant accounts
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminal settings - store level-/stores/:storeId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/stores/:storeId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
POS Terminal Management API (v1)
General-/assignTerminals
Assign a terminal to a store
General-/findTerminal
Find where a terminal is assigned to
General-/getStoresUnderAccount
Get all the stores under a merchant account
General-/getTerminalDetails
Get information about a specific terminal
General-/getTerminalsUnderAccount
Get all the terminals assigned to a store
Transfers API (v4)
Transactions-/transactions
Get all transactions
Transactions-/transactions/:id
Get a transaction
Transfers-/transfers
Get all transfersPay out to a transfer instrument
Transfers-/transfers/:id
Get a transfer
Transfers-/transfers/:transferId/returns
Return an incoming internal transfer
Capital-/grants
Get a capital accountRequest grant payout to a balance account
Capital-/grants/:id
Get grant reference details
Introduction
Adyen Balance Control API (v1)
General-/balanceTransfer
Transfer balances between merchant accounts
Adyen BinLookup API (v54)
General-/get3dsAvailability
Get 3D Secure availability
General-/getCostEstimate
Estimate the transaction cost (recurring contract)
Adyen Checkout API (v71)
Modifications-/cancels
Cancel a payment using your own reference
Modifications-/payments/:paymentPspReference/amountUpdates
Update the amount of an authorised payment
Modifications-/payments/:paymentPspReference/cancels
Cancel payment using a PSP reference
Modifications-/payments/:paymentPspReference/captures
Capture an authorised payment
Modifications-/payments/:paymentPspReference/refunds
Refund a payment
Modifications-/payments/:paymentPspReference/reversals
Reverse (cancel or refund) a payment
Classic Checkout SDK-/paymentSession (DEPRECATED)
Set up a payment session (Web)
Classic Checkout SDK-/payments/result (DEPRECATED)
Verify payment results
Orders-/orders
Create an order
Orders-/orders/cancel
Cancel an order
Orders-/paymentMethods/balance
Get gift card balance specifying amount of 100 EUR
Utility-/applePay/sessions
Get payment session for Apple Pay
Utility-/originKeys (DEPRECATED)
Get origin keys
Utility-/paypal/updateOrder
Update a PayPal order in a Sessions flow integration
Recurring-/storedPaymentMethods
Get tokens for stored payment detailsStore encrypted card details for subscription payments
Recurring-/storedPaymentMethods/:storedPaymentMethodId
Delete a token for stored payment details
Donations-/donationCampaigns
Get a list of active donation campaigns
Donations-/donations
Start a donation transaction with a token
Payments-/cardDetails
Get a list of brands on a card specifying your supported card brands
Payments-/paymentMethods
Get payment methods including stored card details
Payments-/payments
Tokenize card details for a subscription
Payments-/payments/details
Submit 3D Secure 2 authentication result
Payments-/sessions
Split a payment between balance accounts
Payments-/sessions/:sessionId
Get the result of a payment session
Payment links-/paymentLinks
Create a payment link
Payment links-/paymentLinks/:linkId
Get a payment linkUpdate the status of a payment link
Adyen Data Protection API (v1)
General-/requestSubjectErasure
Submit a Subject Erasure Request.
Adyen Payout API (v68)
Initialization-/storeDetail
Store payout details
Initialization-/storeDetailAndSubmitThirdParty
Submit a payout to Skrill
Initialization-/submitThirdParty
Submit a payout
Instant payouts-/payout
Instant card payout (P2P)
Reviewing-/confirmThirdParty
Confirm a payout
Reviewing-/declineThirdParty
Cancel a payout
Adyen Recurring API (v68)
General-/createPermit
Create new permits linked to a recurring contract.
General-/disable
Disable a recurring contract
General-/disablePermit
Disable an existing permit.
General-/listRecurringDetails
List recurring details of the specified contract value
General-/notifyShopper
Request issuer to notify shopper of upcoming recurring payment
General-/scheduleAccountUpdater
Schedule AccountUpdater with token data
Adyen Stored Value API (v46)
General-/changeStatus
Changes the status of the payment method.
General-/checkBalance
Checks the balance.
General-/issue
Issues a new card.
General-/load
Loads the payment method.
General-/mergeBalance
Merge the balance of two cards.
General-/voidTransaction
Voids a transaction.
Adyen Test Cards API (v1)
General-/createTestCardRanges
Creates one or more test card ranges.
Configuration API (v2)
Platform-/balancePlatforms/:id
Get a balance platform
Platform-/balancePlatforms/:id/accountHolders
Get all account holders under a balance platform
Grant offers-/grantOffers
Get all available grant offers
Grant offers-/grantOffers/:grantOfferId
Get a grant offer
Network tokens-/networkTokens/:networkTokenId
Get a network tokenUpdate a network token
Account holders-/accountHolders
Create an account holder
Account holders-/accountHolders/:id
Get an account holderDeactivate an account holder
Account holders-/accountHolders/:id/balanceAccounts
Get all balance accounts of an account holder
Account holders-/accountHolders/:id/taxForms
Get a tax form
Payment instruments-/paymentInstruments
Create a virtual card
Payment instruments-/paymentInstruments/:id
Get a payment instrumentUpdate the status of a payment instrument
Payment instruments-/paymentInstruments/:id/networkTokens
List network tokens
Payment instruments-/paymentInstruments/:id/reveal
Get the PAN of a payment instrument
Payment instruments-/paymentInstruments/:id/transactionRules
Get all transaction rules for a payment instrument
Payment instruments-/paymentInstruments/reveal
Reveal the data of a payment instrument
Grant accounts-/grantAccounts/:id
Get a grant account
Balance accounts-/balanceAccounts
Create a balance account
Balance accounts-/balanceAccounts/:balanceAccountId/sweeps
Get all sweeps for a balance accountCreate a sweep to push funds out of a balance account with set priorities
Balance accounts-/balanceAccounts/:balanceAccountId/sweeps/:sweepId
Delete a sweepGet a sweepUpdate the status of a sweep
Balance accounts-/balanceAccounts/:id
Get a balance accountUpdate the time zone of a balance account
Balance accounts-/balanceAccounts/:id/paymentInstruments
Get payment instruments linked to a balance account
Transaction rules-/transactionRules
Limit international payments
Transaction rules-/transactionRules/:transactionRuleId
Delete a transaction ruleGet a transaction ruleUpdate the interval of transaction rule
Card orders-/cardorders
Get a list of card orders
Card orders-/cardorders/:id/items
Get card order items
Payment instrument groups-/paymentInstrumentGroups
Create a payment instrument group
Payment instrument groups-/paymentInstrumentGroups/:id
Get a payment instrument group
Payment instrument groups-/paymentInstrumentGroups/:id/transactionRules
Get all transaction rules for a payment instrument group
Bank account validation-/validateBankAccountIdentification
Validate a US bank account
Manage card PIN-/pins/change
Request a PIN change
Manage card PIN-/pins/reveal
Request a PIN block
Manage card PIN-/publicKey
Get an RSA public key
Transfer routes-/transferRoutes/calculate
Calculate transfer routes
Manage SCA devices-/registeredDevices
Get a list of registered SCA devicesInitiate the registration of an SCA device
Manage SCA devices-/registeredDevices/:id
Delete a registration of an SCA deviceComplete the registration of an SCA device
Disputes API (v30)
General-/acceptDispute
Accept a dispute
General-/defendDispute
Defend a dispute
General-/deleteDisputeDefenseDocument
Delete a dispute defense document
General-/retrieveApplicableDefenseReasons
Retrieve applicable defense reasons
General-/supplyDefenseDocument
Supply dispute defense documents
Legal Entity Management API (v3)
Legal entities-/legalEntities
Create a legal entity for a trust in Australia
Legal entities-/legalEntities/:id
Get a legal entityAssociate an exempt settlor with a trust
Legal entities-/legalEntities/:id/businessLines
Get all business lines under a legal entity
Legal entities-/legalEntities/:id/checkVerificationErrors
Check a legal entity's verification errors
Legal entities-/legalEntities/:id/confirmDataReview
Confirm data review
Hosted Onboarding-/legalEntities/:id/onboardingLinks
Create a hosted onboarding link
Hosted Onboarding-/themes
Get a list of hosted onboarding page themes
Hosted Onboarding-/themes/:id
Get an onboarding link theme
Business lines-/businessLines
Create a business line for receiving payments
Business lines-/businessLines/:id
Delete a business lineGet a business lineUpdate a business line
Documents-/documents
Upload a document
Documents-/documents/:id
Delete a documentGet a documentUpdate a document
Terms of Service-/legalEntities/:id/termsOfService
Get the Terms of Service document
Terms of Service-/legalEntities/:id/termsOfService/:termsofservicedocumentid
Accept the Terms of Service document
Terms of Service-/legalEntities/:id/termsOfServiceAcceptanceInfos
Get Terms of Service information for a legal entity
Terms of Service-/legalEntities/:id/termsOfServiceStatus
Get Terms of Service status
Transfer instruments-/transferInstruments
Add a USD bank account
Transfer instruments-/transferInstruments/:id
Delete a transfer instrumentGet a transfer instrumentUpdate a transfer instrument
PCI questionnaires-/legalEntities/:id/pciQuestionnaires
Get PCI questionnaire details
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/:pciid
Get PCI questionnaire
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/generatePciTemplates
Generate PCI questionnaires
PCI questionnaires-/legalEntities/:id/pciQuestionnaires/signPciTemplates
Sign PCI questionnaires
Management API
API key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Account - merchant level-/merchants
Get a list of merchant accountsCreate a merchant account for an Adyen for Platforms Manage integration
Account - merchant level-/merchants/:merchantId
Get a merchant account
Account - merchant level-/merchants/:merchantId/activate
Request to activate a merchant account
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations
Get a list of split configurationsCreate a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId
Delete a split configurationGet a split configurationUpdate split configuration descriptionAdd rule to a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId
Delete a split configuration ruleUpdate the conditions in split configuration rule
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId
Update the split logic
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
API key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Client key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Users - company level-/companies/:companyId/users
Get a list of usersCreate a user
Users - company level-/companies/:companyId/users/:userId
Get user detailsUpdate user details
Terminal actions - terminal level-/terminals/scheduleActions
Invalid terminal ID in the request
Terminal settings - terminal level-/terminals/:terminalId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - terminal level-/terminals/:terminalId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Payout settings - merchant level-/merchants/:merchantId/payoutSettings
Get a list of payout settingsAdd a payout setting
Payout settings - merchant level-/merchants/:merchantId/payoutSettings/:payoutSettingsId
Delete a payout settingGet a payout settingUpdate a payout setting
Webhooks - merchant level-/merchants/:merchantId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/test
Test a webhook notification
Client key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
Terminal orders - company level-/companies/:companyId/billingEntities
Get a list of billing entities
Terminal orders - company level-/companies/:companyId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - company level-/companies/:companyId/terminalModels
Get a list of terminal models
Terminal orders - company level-/companies/:companyId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - company level-/companies/:companyId/terminalProducts
Get a list of terminal products
API credentials - merchant level-/merchants/:merchantId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Users - merchant level-/merchants/:merchantId/users
Get a list of usersCreate a user
Users - merchant level-/merchants/:merchantId/users/:userId
Get user detailsUpdate a user
Terminal actions - company level-/companies/:companyId/terminalActions
Get a list of terminal actions
Terminal actions - company level-/companies/:companyId/terminalActions/:actionId
Get terminal action
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings
Get all payment methodsRequest to add Swish
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId
Get payment method detailsUpdate a payment method
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains
Add an Apple Pay domain
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains
Get Apple Pay domains
My API credential-/me
Get API credential details
My API credential-/me/allowedOrigins
Get allowed originsAdd allowed origin
My API credential-/me/allowedOrigins/:originId
Remove allowed originGet allowed origin details
My API credential-/me/generateClientKey
Generate a client key
Terminal settings - merchant level-/merchants/:merchantId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - merchant level-/merchants/:merchantId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminals - terminal level-/terminals
Get a list of terminals
Terminals - terminal level-/terminals/:terminalId/reassign
Reassign a terminal
Webhooks - company level-/companies/:companyId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - company level-/companies/:companyId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/test
Test a webhook notification
Account - store level-/merchants/:merchantId/stores
Get a list of storesCreate a store under the merchant account specified in the path.
Account - store level-/merchants/:merchantId/stores/:storeId
Get a storeAdd split configuration to store
Account - store level-/stores
Get a list of storesCreate a store
Account - store level-/stores/:storeId
Get a storeAdd split configuration to store
Android files - company level-/companies/:companyId/androidApps
Get a list of Android appsUpload Android App
Android files - company level-/companies/:companyId/androidApps/:id
Get Android app
Android files - company level-/companies/:companyId/androidCertificates
Get a list of Android certificates
Terminal settings - company level-/companies/:companyId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - company level-/companies/:companyId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
API credentials - company level-/companies/:companyId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - company level-/companies/:companyId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Terminal orders - merchant level-/merchants/:merchantId/billingEntities
Get a list of billing entities
Terminal orders - merchant level-/merchants/:merchantId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - merchant level-/merchants/:merchantId/terminalModels
Get a list of terminal models
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - merchant level-/merchants/:merchantId/terminalProducts
Get a list of terminal products
Account - company level-/companies
Get a list of company accounts
Account - company level-/companies/:companyId
Get a company account
Account - company level-/companies/:companyId/merchants
Get a list of merchant accounts
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminal settings - store level-/stores/:storeId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/stores/:storeId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Management API (v3)
API key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Account - merchant level-/merchants
Get a list of merchant accountsCreate a merchant account for an Adyen for Platforms Manage integration
Account - merchant level-/merchants/:merchantId
Get a merchant account
Account - merchant level-/merchants/:merchantId/activate
Request to activate a merchant account
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations
Get a list of split configurationsCreate a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId
Delete a split configurationGet a split configurationUpdate split configuration descriptionAdd rule to a split configuration
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId
Delete a split configuration ruleUpdate the conditions in split configuration rule
Split configuration - merchant level-/merchants/:merchantId/splitConfigurations/:splitConfigurationId/rules/:ruleId/splitLogic/:splitLogicId
Update the split logic
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - company level-/companies/:companyId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
API key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateApiKey
Generate new API key
Client key - company level-/companies/:companyId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Users - company level-/companies/:companyId/users
Get a list of usersCreate a user
Users - company level-/companies/:companyId/users/:userId
Get user detailsUpdate user details
Terminal actions - terminal level-/terminals/scheduleActions
Invalid terminal ID in the request
Terminal settings - terminal level-/terminals/:terminalId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - terminal level-/terminals/:terminalId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Payout settings - merchant level-/merchants/:merchantId/payoutSettings
Get a list of payout settingsAdd a payout setting
Payout settings - merchant level-/merchants/:merchantId/payoutSettings/:payoutSettingsId
Delete a payout settingGet a payout settingUpdate a payout setting
Webhooks - merchant level-/merchants/:merchantId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - merchant level-/merchants/:merchantId/webhooks/:webhookId/test
Test a webhook notification
Client key - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/generateClientKey
Generate new client key
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins
Get a list of allowed originsAdd an allowed origin for the API credential
Allowed origins - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId/allowedOrigins/:originId
Delete an allowed originGet an allowed origin
Terminal orders - company level-/companies/:companyId/billingEntities
Get a list of billing entities
Terminal orders - company level-/companies/:companyId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - company level-/companies/:companyId/terminalModels
Get a list of terminal models
Terminal orders - company level-/companies/:companyId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - company level-/companies/:companyId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - company level-/companies/:companyId/terminalProducts
Get a list of terminal products
API credentials - merchant level-/merchants/:merchantId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - merchant level-/merchants/:merchantId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Users - merchant level-/merchants/:merchantId/users
Get a list of usersCreate a user
Users - merchant level-/merchants/:merchantId/users/:userId
Get user detailsUpdate a user
Terminal actions - company level-/companies/:companyId/terminalActions
Get a list of terminal actions
Terminal actions - company level-/companies/:companyId/terminalActions/:actionId
Get terminal action
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings
Get all payment methodsRequest to add Swish
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId
Get payment method detailsUpdate a payment method
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/addApplePayDomains
Add an Apple Pay domain
Payment methods - merchant level-/merchants/:merchantId/paymentMethodSettings/:paymentMethodId/getApplePayDomains
Get Apple Pay domains
My API credential-/me
Get API credential details
My API credential-/me/allowedOrigins
Get allowed originsAdd allowed origin
My API credential-/me/allowedOrigins/:originId
Remove allowed originGet allowed origin details
My API credential-/me/generateClientKey
Generate a client key
Terminal settings - merchant level-/merchants/:merchantId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - merchant level-/merchants/:merchantId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminals - terminal level-/terminals
Get a list of terminals
Terminals - terminal level-/terminals/:terminalId/reassign
Reassign a terminal
Webhooks - company level-/companies/:companyId/webhooks
List all webhooksAdd a webhook configuration
Webhooks - company level-/companies/:companyId/webhooks/:webhookId
Remove a webhookGet a webhookActivate the webhook
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/generateHmac
Generate an HMAC key
Webhooks - company level-/companies/:companyId/webhooks/:webhookId/test
Test a webhook notification
Account - store level-/merchants/:merchantId/stores
Get a list of storesCreate a store under the merchant account specified in the path.
Account - store level-/merchants/:merchantId/stores/:storeId
Get a storeAdd split configuration to store
Account - store level-/stores
Get a list of storesCreate a store
Account - store level-/stores/:storeId
Get a storeAdd split configuration to store
Android files - company level-/companies/:companyId/androidApps
Get a list of Android appsUpload Android App
Android files - company level-/companies/:companyId/androidApps/:id
Get Android app
Android files - company level-/companies/:companyId/androidCertificates
Get a list of Android certificates
Terminal settings - company level-/companies/:companyId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - company level-/companies/:companyId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
API credentials - company level-/companies/:companyId/apiCredentials
Get a list of API credentialsAdd an API credential
API credentials - company level-/companies/:companyId/apiCredentials/:apiCredentialId
Get an API credentialActivate an API credential
Terminal orders - merchant level-/merchants/:merchantId/billingEntities
Get a list of billing entities
Terminal orders - merchant level-/merchants/:merchantId/shippingLocations
Get a list of shipping locationsCreate a shipping location
Terminal orders - merchant level-/merchants/:merchantId/terminalModels
Get a list of terminal models
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders
Get a list of ordersCreate an order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId
Get an orderUpdate a terminal order
Terminal orders - merchant level-/merchants/:merchantId/terminalOrders/:orderId/cancel
Cancel an order
Terminal orders - merchant level-/merchants/:merchantId/terminalProducts
Get a list of terminal products
Account - company level-/companies
Get a list of company accounts
Account - company level-/companies/:companyId
Get a company account
Account - company level-/companies/:companyId/merchants
Get a list of merchant accounts
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/merchants/:merchantId/stores/:reference/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
Terminal settings - store level-/stores/:storeId/terminalLogos
Get the terminal logoUpload terminal logo
Terminal settings - store level-/stores/:storeId/terminalSettings
Get terminal settingsAdd EAP-TLS Wi-Fi profile
POS Terminal Management API (v1)
General-/assignTerminals
Assign a terminal to a store
General-/findTerminal
Find where a terminal is assigned to
General-/getStoresUnderAccount
Get all the stores under a merchant account
General-/getTerminalDetails
Get information about a specific terminal
General-/getTerminalsUnderAccount
Get all the terminals assigned to a store
Transfers API (v4)
Transactions-/transactions
Get all transactions
Transactions-/transactions/:id
Get a transaction
Transfers-/transfers
Get all transfersPay out to a transfer instrument
Transfers-/transfers/:id
Get a transfer
Transfers-/transfers/:transferId/returns
Return an incoming internal transfer
Capital-/grants
Get a capital accountRequest grant payout to a balance account
Capital-/grants/:id
Get grant reference details
HomeLegal Entity Management API (v3)Business lines-/businessLines/:id

Business lines-/businessLines/:id

Number of APIs: 3

  1. Delete a business line DELETE {{baseUrl}}/businessLines/:id

  2. Get a business line GET {{baseUrl}}/businessLines/:id

  3. Update a business line PATCH {{baseUrl}}/businessLines/:id

Previous
Create a business line for receiving payments
Next
Delete a business line