Package com.adyen.service.balanceplatform

Class PlatformApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.PlatformApi

public class PlatformApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PlatformApi(Client client)	Platform constructor in package.
PlatformApi(Client client, String baseURL)	Platform constructor in package.

Method Summary

Modifier and Type	Method	Description
PaginatedAccountHoldersResponse	getAllAccountHoldersUnderBalancePlatform(String id)	Get all account holders under a balance platform
PaginatedAccountHoldersResponse	getAllAccountHoldersUnderBalancePlatform(String id, Integer offset, Integer limit, RequestOptions requestOptions)	Get all account holders under a balance platform
BalancePlatform	getBalancePlatform(String id)	Get a balance platform
BalancePlatform	getBalancePlatform(String id, RequestOptions requestOptions)	Get a balance platform

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

PlatformApi

public PlatformApi(Client client)

Platform constructor in package.

Parameters:

client - Client (required)

PlatformApi

public PlatformApi(Client client,
                   String baseURL)

Platform 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

getAllAccountHoldersUnderBalancePlatform

public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id)
                                                                         throws ApiException,
                                                                                IOException

Get all account holders under a balance platform

Parameters:

id - String The unique identifier of the balance platform. (required)

Returns:

PaginatedAccountHoldersResponse

Throws:

ApiException - if fails to make API call

IOException

getAllAccountHoldersUnderBalancePlatform

public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id,
                                                                                Integer offset,
                                                                                Integer limit,
                                                                                RequestOptions requestOptions)
                                                                         throws ApiException,
                                                                                IOException

Get all account holders under a balance platform

Parameters:

id - String The unique identifier of the balance platform. (required)

offset - Integer Query: The number of items that you want to skip. (optional)

limit - Integer Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

PaginatedAccountHoldersResponse

Throws:

ApiException - if fails to make API call

IOException

getBalancePlatform

public BalancePlatform getBalancePlatform(String id)
                                   throws ApiException,
                                          IOException

Get a balance platform

Parameters:

id - String The unique identifier of the balance platform. (required)

Returns:

BalancePlatform

Throws:

ApiException - if fails to make API call

IOException

getBalancePlatform

public BalancePlatform getBalancePlatform(String id,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Get a balance platform

Parameters:

id - String The unique identifier of the balance platform. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

BalancePlatform

Throws:

ApiException - if fails to make API call

IOException