adyen.com – BalancePlatformService

Tools (33)

Extracted live via the executor SDK.

• accountHolders.getAccountHoldersId

  Returns an account holder.

• accountHolders.getAccountHoldersIdBalanceAccounts

  Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters.

  For example, to limit the page to 5 balance accounts and skip the first 10, use /accountHolders/{id}/balanceAccounts?limit=5&offset=10.

• accountHolders.patchAccountHoldersId

  Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.

• accountHolders.postAccountHolders

  Creates an account holder linked to a legal entity.

• balanceAccounts.deleteBalanceAccountsBalanceAccountIdSweepsSweepId

  Deletes a sweep for a balance account.

• balanceAccounts.getBalanceAccountsBalanceAccountIdSweeps

  Returns a list of the sweeps configured for a balance account.

  To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use /balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10.

• balanceAccounts.getBalanceAccountsBalanceAccountIdSweepsSweepId

  Returns a sweep.

• balanceAccounts.getBalanceAccountsId

  Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.

• balanceAccounts.getBalanceAccountsIdPaymentInstruments

  Returns a paginated list of the payment instruments associated with a balance account.

  To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use /balanceAccounts/{id}/paymentInstruments?limit=3&offset=6.

• balanceAccounts.patchBalanceAccountsBalanceAccountIdSweepsSweepId

  Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.

• balanceAccounts.patchBalanceAccountsId

  Updates a balance account.

• balanceAccounts.postBalanceAccounts

  Creates a balance account that holds the funds of the associated account holder.

• balanceAccounts.postBalanceAccountsBalanceAccountIdSweeps

  Creates a sweep that results in moving funds from or to a balance account.

  A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.

• bankAccountValidation.postValidateBankAccountIdentification

  Validates bank account identification details. You can use this endpoint to validate bank account details before you make a transfer or create a transfer instrument.

• grantAccounts.getGrantAccountsId

  Returns the details of the grant account.

• grantOffers.getGrantOffers

  Returns a list of all grant offers available for accountHolderId specified as a query parameter.

• grantOffers.getGrantOffersGrantOfferId

  Returns the details of a single grant offer.

• paymentInstrumentGroups.getPaymentInstrumentGroupsId

  Returns the details of a payment instrument group.

• paymentInstrumentGroups.getPaymentInstrumentGroupsIdTransactionRules

  Returns a list of all the transaction rules associated with a payment instrument group.

• paymentInstrumentGroups.postPaymentInstrumentGroups

  Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.

• paymentInstruments.getPaymentInstrumentsId

  Returns the details of a payment instrument.

• paymentInstruments.getPaymentInstrumentsIdReveal

  Returns the primary account number (PAN) of a payment instrument.

  To make this request, your API credential must have the following role:

  • Balance Platform BCL PCI role
• paymentInstruments.getPaymentInstrumentsIdTransactionRules

  Returns a list of transaction rules associated with a payment instrument.

• paymentInstruments.patchPaymentInstrumentsId

  Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with inactive status, you can still update the balance account associated with the card.

• paymentInstruments.postPaymentInstruments

  Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.

  For more information, refer to Issue cards or Issue business accounts.

• platform.getBalancePlatformsId

  Returns a balance platform.

• platform.getBalancePlatformsIdAccountHolders

  Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters.

  For example, to limit the page to 5 account holders and to skip the first 20, use /balancePlatforms/{id}/accountHolders?limit=5&offset=20.

• transactionRules.deleteTransactionRulesTransactionRuleId

  Deletes a transaction rule.

• transactionRules.getTransactionRulesTransactionRuleId

  Returns the details of a transaction rule.

• transactionRules.patchTransactionRulesTransactionRuleId

  Updates a transaction rule.

  • To update only the status of a transaction rule, send only the status parameter. All other parameters not provided in the request are left unchanged.

  • When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.

• transactionRules.postTransactionRules

  Creates a transaction rule. When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see examples.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools