Configuration API

Configuration API

API version: 2

Auth

ApiKey X-API-Key in header | Bearer basic | ApiKey clientKey in query

Base URL

https://balanceplatform-api-test.adyen.com/bcl/v2

Setup

1. Set Authorization header with your Bearer token
2. GET /cardorders -- verify access
3. POST /accountHolders -- create first accountHolders

Endpoints

79 endpoints across 17 groups. See references/api-spec.lap for full details.

accountHolders

balanceAccounts

balancePlatforms

cardorders

grantAccounts

grantOffers

networkTokens

paymentInstrumentGroups

paymentInstruments

pins

publicKey

registeredDevices

transactionRules

transferRoutes

validateBankAccountIdentification

scaAssociations

scaDevices

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a accountHolder?" -> POST /accountHolders
• "Get accountHolder details?" -> GET /accountHolders/{id}
• "Partially update a accountHolder?" -> PATCH /accountHolders/{id}
• "List all balanceAccounts?" -> GET /accountHolders/{id}/balanceAccounts
• "List all taxForms?" -> GET /accountHolders/{id}/taxForms
• "List all transactionRules?" -> GET /accountHolders/{id}/transactionRules
• "Create a balanceAccount?" -> POST /balanceAccounts
• "List all sweeps?" -> GET /balanceAccounts/{balanceAccountId}/sweeps
• "Create a sweep?" -> POST /balanceAccounts/{balanceAccountId}/sweeps
• "Get sweep details?" -> GET /balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
• "Delete a sweep?" -> DELETE /balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
• "Partially update a sweep?" -> PATCH /balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
• "Get balanceAccount details?" -> GET /balanceAccounts/{id}
• "Partially update a balanceAccount?" -> PATCH /balanceAccounts/{id}
• "List all paymentInstruments?" -> GET /balanceAccounts/{id}/paymentInstruments
• "List all transactionRules?" -> GET /balanceAccounts/{id}/transactionRules
• "Get balancePlatform details?" -> GET /balancePlatforms/{id}
• "List all accountHolders?" -> GET /balancePlatforms/{id}/accountHolders
• "List all transactionRules?" -> GET /balancePlatforms/{id}/transactionRules
• "List all cardorders?" -> GET /cardorders
• "List all items?" -> GET /cardorders/{id}/items
• "Get grantAccount details?" -> GET /grantAccounts/{id}
• "List all grantOffers?" -> GET /grantOffers
• "Get grantOffer details?" -> GET /grantOffers/{grantOfferId}
• "Get networkToken details?" -> GET /networkTokens/{networkTokenId}
• "Partially update a networkToken?" -> PATCH /networkTokens/{networkTokenId}
• "Create a paymentInstrumentGroup?" -> POST /paymentInstrumentGroups
• "Get paymentInstrumentGroup details?" -> GET /paymentInstrumentGroups/{id}
• "List all transactionRules?" -> GET /paymentInstrumentGroups/{id}/transactionRules
• "Create a paymentInstrument?" -> POST /paymentInstruments
• "Create a reveal?" -> POST /paymentInstruments/reveal
• "Get paymentInstrument details?" -> GET /paymentInstruments/{id}
• "Partially update a paymentInstrument?" -> PATCH /paymentInstruments/{id}
• "List all networkTokenActivationData?" -> GET /paymentInstruments/{id}/networkTokenActivationData
• "Create a networkTokenActivationData?" -> POST /paymentInstruments/{id}/networkTokenActivationData
• "List all networkTokens?" -> GET /paymentInstruments/{id}/networkTokens
• "List all reveal?" -> GET /paymentInstruments/{id}/reveal
• "List all transactionRules?" -> GET /paymentInstruments/{id}/transactionRules
• "Create a change?" -> POST /pins/change
• "Create a reveal?" -> POST /pins/reveal
• "List all publicKey?" -> GET /publicKey
• "List all registeredDevices?" -> GET /registeredDevices
• "Create a registeredDevice?" -> POST /registeredDevices
• "Create a association?" -> POST /registeredDevices/{deviceId}/associations
• "Delete a registeredDevice?" -> DELETE /registeredDevices/{id}
• "Partially update a registeredDevice?" -> PATCH /registeredDevices/{id}
• "Create a transactionRule?" -> POST /transactionRules
• "Get transactionRule details?" -> GET /transactionRules/{transactionRuleId}
• "Delete a transactionRule?" -> DELETE /transactionRules/{transactionRuleId}
• "Partially update a transactionRule?" -> PATCH /transactionRules/{transactionRuleId}
• "Create a calculate?" -> POST /transferRoutes/calculate
• "Create a validateBankAccountIdentification?" -> POST /validateBankAccountIdentification
• "List all authorisedCardUsers?" -> GET /paymentInstruments/{paymentInstrumentId}/authorisedCardUsers
• "Create a authorisedCardUser?" -> POST /paymentInstruments/{paymentInstrumentId}/authorisedCardUsers
• "List all settings?" -> GET /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings
• "Create a setting?" -> POST /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings
• "Get setting details?" -> GET /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}
• "Delete a setting?" -> DELETE /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}
• "Partially update a setting?" -> PATCH /balancePlatforms/{balancePlatformId}/webhooks/{webhookId}/settings/{settingId}
• "List all scaAssociations?" -> GET /scaAssociations
• "Create a scaDevice?" -> POST /scaDevices
• "Partially update a scaDevice?" -> PATCH /scaDevices/{deviceId}
• "Create a scaAssociation?" -> POST /scaDevices/{deviceId}/scaAssociations
• "List all taxFormSummary?" -> GET /accountHolders/{id}/taxFormSummary
• "Create a approve?" -> POST /balanceAccounts/{id}/transferLimits/approve
• "List all transferLimits?" -> GET /balanceAccounts/{id}/transferLimits
• "Create a transferLimit?" -> POST /balanceAccounts/{id}/transferLimits
• "List all current?" -> GET /balanceAccounts/{id}/transferLimits/current
• "Get transferLimit details?" -> GET /balanceAccounts/{id}/transferLimits/{transferLimitId}
• "Delete a transferLimit?" -> DELETE /balanceAccounts/{id}/transferLimits/{transferLimitId}
• "List all transferLimits?" -> GET /balancePlatforms/{id}/transferLimits
• "Create a transferLimit?" -> POST /balancePlatforms/{id}/transferLimits
• "Get transferLimit details?" -> GET /balancePlatforms/{id}/transferLimits/{transferLimitId}
• "Delete a transferLimit?" -> DELETE /balancePlatforms/{id}/transferLimits/{transferLimitId}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP