java.lang.Object
- com.adyen.Service
- - com.adyen.service.classicplatforms.ClassicPlatformFundApi

public class ClassicPlatformFundApi
extends Service

Field Summary

Fields
Modifier and Type Field Description

static String API_VERSION

protected String baseURL

Constructor Summary

Constructors
Constructor	Description
`ClassicPlatformFundApi(Client client)`	General constructor in `package`.
`ClassicPlatformFundApi(Client client, String baseURL)`	General constructor in `package`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccountHolderBalanceResponse`	`accountHolderBalance(AccountHolderBalanceRequest accountHolderBalanceRequest)`	Get the balances of an account holder
`AccountHolderBalanceResponse`	`accountHolderBalance(AccountHolderBalanceRequest accountHolderBalanceRequest, RequestOptions requestOptions)`	Get the balances of an account holder
`AccountHolderTransactionListResponse`	`accountHolderTransactionList(AccountHolderTransactionListRequest accountHolderTransactionListRequest)`	Get a list of transactions
`AccountHolderTransactionListResponse`	`accountHolderTransactionList(AccountHolderTransactionListRequest accountHolderTransactionListRequest, RequestOptions requestOptions)`	Get a list of transactions
`DebitAccountHolderResponse`	`debitAccountHolder(DebitAccountHolderRequest debitAccountHolderRequest)`	Send a direct debit request
`DebitAccountHolderResponse`	`debitAccountHolder(DebitAccountHolderRequest debitAccountHolderRequest, RequestOptions requestOptions)`	Send a direct debit request
`PayoutAccountHolderResponse`	`payoutAccountHolder(PayoutAccountHolderRequest payoutAccountHolderRequest)`	Pay out from an account to the account holder
`PayoutAccountHolderResponse`	`payoutAccountHolder(PayoutAccountHolderRequest payoutAccountHolderRequest, RequestOptions requestOptions)`	Pay out from an account to the account holder
`RefundFundsTransferResponse`	`refundFundsTransfer(RefundFundsTransferRequest refundFundsTransferRequest)`	Refund a funds transfer
`RefundFundsTransferResponse`	`refundFundsTransfer(RefundFundsTransferRequest refundFundsTransferRequest, RequestOptions requestOptions)`	Refund a funds transfer
`RefundNotPaidOutTransfersResponse`	`refundNotPaidOutTransfers(RefundNotPaidOutTransfersRequest refundNotPaidOutTransfersRequest)`	Refund all transactions of an account since the most recent payout
`RefundNotPaidOutTransfersResponse`	`refundNotPaidOutTransfers(RefundNotPaidOutTransfersRequest refundNotPaidOutTransfersRequest, RequestOptions requestOptions)`	Refund all transactions of an account since the most recent payout
`SetupBeneficiaryResponse`	`setupBeneficiary(SetupBeneficiaryRequest setupBeneficiaryRequest)`	Designate a beneficiary account and transfer the benefactor's current balance
`SetupBeneficiaryResponse`	`setupBeneficiary(SetupBeneficiaryRequest setupBeneficiaryRequest, RequestOptions requestOptions)`	Designate a beneficiary account and transfer the benefactor's current balance
`TransferFundsResponse`	`transferFunds(TransferFundsRequest transferFundsRequest)`	Transfer funds between platform accounts
`TransferFundsResponse`	`transferFunds(TransferFundsRequest transferFundsRequest, RequestOptions requestOptions)`	Transfer funds between platform accounts

Methods inherited from class com.adyen.Service
createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_VERSION
```
public static final String API_VERSION
```
See Also:

Constant Field Values

baseURL
```
protected String baseURL
```

Constructor Detail
- ClassicPlatformFundApi
```
public ClassicPlatformFundApi(Client client)
```
  General constructor in package.
  
  Parameters:
  
  client - Client (required)
- ClassicPlatformFundApi
```
public ClassicPlatformFundApi(Client client,
                              String baseURL)
```
  General constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
  
  Parameters:
  
  client - Client (required)
  
  baseURL - String (required)

Method Detail

accountHolderBalance

public AccountHolderBalanceResponse accountHolderBalance(AccountHolderBalanceRequest accountHolderBalanceRequest)
                                                  throws ApiException,
                                                         IOException

Get the balances of an account holder

Parameters:: accountHolderBalanceRequest - AccountHolderBalanceRequest (required)
Returns:: AccountHolderBalanceResponse
Throws:: ApiException - if fails to make API call; IOException

accountHolderBalance

public AccountHolderBalanceResponse accountHolderBalance(AccountHolderBalanceRequest accountHolderBalanceRequest,
                                                         RequestOptions requestOptions)
                                                  throws ApiException,
                                                         IOException

Get the balances of an account holder

Parameters:: accountHolderBalanceRequest - AccountHolderBalanceRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: AccountHolderBalanceResponse
Throws:: ApiException - if fails to make API call; IOException

accountHolderTransactionList

public AccountHolderTransactionListResponse accountHolderTransactionList(AccountHolderTransactionListRequest accountHolderTransactionListRequest)
                                                                  throws ApiException,
                                                                         IOException

Get a list of transactions

Parameters:: accountHolderTransactionListRequest - AccountHolderTransactionListRequest (required)
Returns:: AccountHolderTransactionListResponse
Throws:: ApiException - if fails to make API call; IOException

accountHolderTransactionList

public AccountHolderTransactionListResponse accountHolderTransactionList(AccountHolderTransactionListRequest accountHolderTransactionListRequest,
                                                                         RequestOptions requestOptions)
                                                                  throws ApiException,
                                                                         IOException

Get a list of transactions

Parameters:: accountHolderTransactionListRequest - AccountHolderTransactionListRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: AccountHolderTransactionListResponse
Throws:: ApiException - if fails to make API call; IOException

debitAccountHolder

public DebitAccountHolderResponse debitAccountHolder(DebitAccountHolderRequest debitAccountHolderRequest)
                                              throws ApiException,
                                                     IOException

Send a direct debit request

Parameters:: debitAccountHolderRequest - DebitAccountHolderRequest (required)
Returns:: DebitAccountHolderResponse
Throws:: ApiException - if fails to make API call; IOException

debitAccountHolder

public DebitAccountHolderResponse debitAccountHolder(DebitAccountHolderRequest debitAccountHolderRequest,
                                                     RequestOptions requestOptions)
                                              throws ApiException,
                                                     IOException

Send a direct debit request

Parameters:: debitAccountHolderRequest - DebitAccountHolderRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: DebitAccountHolderResponse
Throws:: ApiException - if fails to make API call; IOException

payoutAccountHolder

public PayoutAccountHolderResponse payoutAccountHolder(PayoutAccountHolderRequest payoutAccountHolderRequest)
                                                throws ApiException,
                                                       IOException

Pay out from an account to the account holder

Parameters:: payoutAccountHolderRequest - PayoutAccountHolderRequest (required)
Returns:: PayoutAccountHolderResponse
Throws:: ApiException - if fails to make API call; IOException

payoutAccountHolder

public PayoutAccountHolderResponse payoutAccountHolder(PayoutAccountHolderRequest payoutAccountHolderRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Pay out from an account to the account holder

Parameters:: payoutAccountHolderRequest - PayoutAccountHolderRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: PayoutAccountHolderResponse
Throws:: ApiException - if fails to make API call; IOException

refundFundsTransfer

public RefundFundsTransferResponse refundFundsTransfer(RefundFundsTransferRequest refundFundsTransferRequest)
                                                throws ApiException,
                                                       IOException

Refund a funds transfer

Parameters:: refundFundsTransferRequest - RefundFundsTransferRequest (required)
Returns:: RefundFundsTransferResponse
Throws:: ApiException - if fails to make API call; IOException

refundFundsTransfer

public RefundFundsTransferResponse refundFundsTransfer(RefundFundsTransferRequest refundFundsTransferRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Refund a funds transfer

Parameters:: refundFundsTransferRequest - RefundFundsTransferRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: RefundFundsTransferResponse
Throws:: ApiException - if fails to make API call; IOException

refundNotPaidOutTransfers

public RefundNotPaidOutTransfersResponse refundNotPaidOutTransfers(RefundNotPaidOutTransfersRequest refundNotPaidOutTransfersRequest)
                                                            throws ApiException,
                                                                   IOException

Refund all transactions of an account since the most recent payout

Parameters:: refundNotPaidOutTransfersRequest - RefundNotPaidOutTransfersRequest (required)
Returns:: RefundNotPaidOutTransfersResponse
Throws:: ApiException - if fails to make API call; IOException

refundNotPaidOutTransfers

public RefundNotPaidOutTransfersResponse refundNotPaidOutTransfers(RefundNotPaidOutTransfersRequest refundNotPaidOutTransfersRequest,
                                                                   RequestOptions requestOptions)
                                                            throws ApiException,
                                                                   IOException

Refund all transactions of an account since the most recent payout

Parameters:: refundNotPaidOutTransfersRequest - RefundNotPaidOutTransfersRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: RefundNotPaidOutTransfersResponse
Throws:: ApiException - if fails to make API call; IOException

setupBeneficiary

public SetupBeneficiaryResponse setupBeneficiary(SetupBeneficiaryRequest setupBeneficiaryRequest)
                                          throws ApiException,
                                                 IOException

Designate a beneficiary account and transfer the benefactor's current balance

Parameters:: setupBeneficiaryRequest - SetupBeneficiaryRequest (required)
Returns:: SetupBeneficiaryResponse
Throws:: ApiException - if fails to make API call; IOException

setupBeneficiary

public SetupBeneficiaryResponse setupBeneficiary(SetupBeneficiaryRequest setupBeneficiaryRequest,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Designate a beneficiary account and transfer the benefactor's current balance

Parameters:: setupBeneficiaryRequest - SetupBeneficiaryRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: SetupBeneficiaryResponse
Throws:: ApiException - if fails to make API call; IOException

transferFunds

public TransferFundsResponse transferFunds(TransferFundsRequest transferFundsRequest)
                                    throws ApiException,
                                           IOException

Transfer funds between platform accounts

Parameters:: transferFundsRequest - TransferFundsRequest (required)
Returns:: TransferFundsResponse
Throws:: ApiException - if fails to make API call; IOException

transferFunds

public TransferFundsResponse transferFunds(TransferFundsRequest transferFundsRequest,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Transfer funds between platform accounts

Parameters:: transferFundsRequest - TransferFundsRequest (required); requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
Returns:: TransferFundsResponse
Throws:: ApiException - if fails to make API call; IOException

Fields
Modifier and Type	Field	Description
`static String`	`API_VERSION`
`protected String`	`baseURL`

Class ClassicPlatformFundApi

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.adyen.Service

Methods inherited from class java.lang.Object

Field Detail

API_VERSION

baseURL

Constructor Detail

ClassicPlatformFundApi

ClassicPlatformFundApi

Method Detail

accountHolderBalance

accountHolderBalance

accountHolderTransactionList

accountHolderTransactionList

debitAccountHolder

debitAccountHolder

payoutAccountHolder

payoutAccountHolder

refundFundsTransfer

refundFundsTransfer

refundNotPaidOutTransfers

refundNotPaidOutTransfers

setupBeneficiary

setupBeneficiary

transferFunds

transferFunds