Own Transfers? Customize your docs with AI search, analytics, and more.
Own Transfers? Customize your docs with AI search, analytics, and more.
The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. ## Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication. For example: ``` curl -H "Content-Type: application/json" \ -U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \ ... ``` ## Versioning The Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number. For example: ``` https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders ``` ##
https://balanceplatform-api-test.adyen.com/bcl/v231 endpoints available
/grantOffersGet all available grant offers
/accountHoldersCreate an account holder
/balanceAccountsCreate a balance account
/transactionRulesCreate a transaction rule
/grantAccounts/{id}Get a grant account
/paymentInstrumentsCreate a payment instrument
/accountHolders/{id}Get an account holder
/accountHolders/{id}Update an account holder
/balanceAccounts/{id}Get a balance account
/balanceAccounts/{id}Update a balance account
/balancePlatforms/{id}Get a balance platform
/paymentInstrumentGroupsCreate a payment instrument group
/paymentInstruments/{id}Get a payment instrument
/paymentInstruments/{id}Update a payment instrument
/grantOffers/{grantOfferId}Get a grant offer
/paymentInstrumentGroups/{id}Get a payment instrument group
/paymentInstruments/{id}/revealGet the PAN of a payment instrument
/validateBankAccountIdentificationValidate a bank account
/accountHolders/{id}/balanceAccountsGet all balance accounts of an account holder
/balancePlatforms/{id}/accountHoldersGet all account holders under a balance platform
/transactionRules/{transactionRuleId}Get a transaction rule
/transactionRules/{transactionRuleId}Update a transaction rule
/transactionRules/{transactionRuleId}Delete a transaction rule
/balanceAccounts/{id}/paymentInstrumentsGet all payment instruments for a balance account
/paymentInstruments/{id}/transactionRulesGet all transaction rules for a payment instrument
/balanceAccounts/{balanceAccountId}/sweepsGet all sweeps for a balance account
/balanceAccounts/{balanceAccountId}/sweepsCreate a sweep
/paymentInstrumentGroups/{id}/transactionRulesGet all transaction rules for a payment instrument group
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Get a sweep
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Update a sweep
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Delete a sweep
The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. ## Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication. For example: ``` curl -H "Content-Type: application/json" \ -U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \ ... ``` ## Versioning The Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number. For example: ``` https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders ``` ##
https://balanceplatform-api-test.adyen.com/bcl/v231 endpoints available
/grantOffersGet all available grant offers
/accountHoldersCreate an account holder
/balanceAccountsCreate a balance account
/transactionRulesCreate a transaction rule
/grantAccounts/{id}Get a grant account
/paymentInstrumentsCreate a payment instrument
/accountHolders/{id}Get an account holder
/accountHolders/{id}Update an account holder
/balanceAccounts/{id}Get a balance account
/balanceAccounts/{id}Update a balance account
/balancePlatforms/{id}Get a balance platform
/paymentInstrumentGroupsCreate a payment instrument group
/paymentInstruments/{id}Get a payment instrument
/paymentInstruments/{id}Update a payment instrument
/grantOffers/{grantOfferId}Get a grant offer
/paymentInstrumentGroups/{id}Get a payment instrument group
/paymentInstruments/{id}/revealGet the PAN of a payment instrument
/validateBankAccountIdentificationValidate a bank account
/accountHolders/{id}/balanceAccountsGet all balance accounts of an account holder
/balancePlatforms/{id}/accountHoldersGet all account holders under a balance platform
/transactionRules/{transactionRuleId}Get a transaction rule
/transactionRules/{transactionRuleId}Update a transaction rule
/transactionRules/{transactionRuleId}Delete a transaction rule
/balanceAccounts/{id}/paymentInstrumentsGet all payment instruments for a balance account
/paymentInstruments/{id}/transactionRulesGet all transaction rules for a payment instrument
/balanceAccounts/{balanceAccountId}/sweepsGet all sweeps for a balance account
/balanceAccounts/{balanceAccountId}/sweepsCreate a sweep
/paymentInstrumentGroups/{id}/transactionRulesGet all transaction rules for a payment instrument group
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Get a sweep
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Update a sweep
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}Delete a sweep