Package com.adyen.service.balanceplatform

Class TransferLimitsBalancePlatformLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.TransferLimitsBalancePlatformLevelApi

public class TransferLimitsBalancePlatformLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TransferLimitsBalancePlatformLevelApi(Client client)	Transfer limits - balance platform level constructor in package.
TransferLimitsBalancePlatformLevelApi(Client client, String baseURL)	Transfer limits - balance platform level constructor in package.

Method Summary

Modifier and Type	Method	Description
TransferLimit	createTransferLimit(String id, CreateTransferLimitRequest createTransferLimitRequest)	Create a transfer limit
TransferLimit	createTransferLimit(String id, CreateTransferLimitRequest createTransferLimitRequest, RequestOptions requestOptions)	Create a transfer limit
void	deletePendingTransferLimit(String id, String transferLimitId)	Delete a scheduled or pending transfer limit
void	deletePendingTransferLimit(String id, String transferLimitId, RequestOptions requestOptions)	Delete a scheduled or pending transfer limit
TransferLimit	getSpecificTransferLimit(String id, String transferLimitId)	Get the details of a transfer limit
TransferLimit	getSpecificTransferLimit(String id, String transferLimitId, RequestOptions requestOptions)	Get the details of a transfer limit
TransferLimitListResponse	getTransferLimits(String id)	Filter and view the transfer limits
TransferLimitListResponse	getTransferLimits(String id, Scope scope, TransferType transferType, LimitStatus status, RequestOptions requestOptions)	Filter and view the transfer limits

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

TransferLimitsBalancePlatformLevelApi

public TransferLimitsBalancePlatformLevelApi(Client client)

Transfer limits - balance platform level constructor in package.

Parameters:

client - Client (required)

TransferLimitsBalancePlatformLevelApi

public TransferLimitsBalancePlatformLevelApi(Client client,
                                             String baseURL)

Transfer limits - balance platform level 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

createTransferLimit

public TransferLimit createTransferLimit(String id,
                                         CreateTransferLimitRequest createTransferLimitRequest)
                                  throws ApiException,
                                         IOException

Create a transfer limit

Parameters:

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

createTransferLimitRequest - CreateTransferLimitRequest (required)

Returns:

TransferLimit

Throws:

ApiException - if fails to make API call

IOException

createTransferLimit

public TransferLimit createTransferLimit(String id,
                                         CreateTransferLimitRequest createTransferLimitRequest,
                                         RequestOptions requestOptions)
                                  throws ApiException,
                                         IOException

Create a transfer limit

Parameters:

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

createTransferLimitRequest - CreateTransferLimitRequest (required)

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

Returns:

TransferLimit

Throws:

ApiException - if fails to make API call

IOException

deletePendingTransferLimit

public void deletePendingTransferLimit(String id,
                                       String transferLimitId)
                                throws ApiException,
                                       IOException

Delete a scheduled or pending transfer limit

Parameters:

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

transferLimitId - String The unique identifier of the transfer limit. (required)

Throws:

ApiException - if fails to make API call

IOException

deletePendingTransferLimit

public void deletePendingTransferLimit(String id,
                                       String transferLimitId,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Delete a scheduled or pending transfer limit

Parameters:

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

transferLimitId - String The unique identifier of the transfer limit. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getSpecificTransferLimit

public TransferLimit getSpecificTransferLimit(String id,
                                              String transferLimitId)
                                       throws ApiException,
                                              IOException

Get the details of a transfer limit

Parameters:

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

transferLimitId - String The unique identifier of the transfer limit. (required)

Returns:

TransferLimit

Throws:

ApiException - if fails to make API call

IOException

getSpecificTransferLimit

public TransferLimit getSpecificTransferLimit(String id,
                                              String transferLimitId,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Get the details of a transfer limit

Parameters:

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

transferLimitId - String The unique identifier of the transfer limit. (required)

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

Returns:

TransferLimit

Throws:

ApiException - if fails to make API call

IOException

getTransferLimits

public TransferLimitListResponse getTransferLimits(String id)
                                            throws ApiException,
                                                   IOException

Filter and view the transfer limits

Parameters:

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

Returns:

TransferLimitListResponse

Throws:

ApiException - if fails to make API call

IOException

getTransferLimits

public TransferLimitListResponse getTransferLimits(String id,
                                                   Scope scope,
                                                   TransferType transferType,
                                                   LimitStatus status,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Filter and view the transfer limits

Parameters:

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

scope - Scope Query: The scope to which the transfer limit applies. Possible values: * **perTransaction**: you set a maximum amount for each transfer made from the balance account or balance platform. * **perDay**: you set a maximum total amount for all transfers made from the balance account or balance platform in a day. (optional)

transferType - TransferType Query: The type of transfer to which the limit applies. Possible values: * **instant**: the limit applies to transfers with an **instant** priority. * **all**: the limit applies to all transfers, regardless of priority. (optional)

status - LimitStatus Query: The status of the transfer limit. Possible values: * **active**: the limit is currently active. * **inactive**: the limit is currently inactive. * **pendingSCA**: the limit is pending until your user performs SCA. * **scheduled**: the limit is scheduled to become active at a future date. (optional)

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

Returns:

TransferLimitListResponse

Throws:

ApiException - if fails to make API call

IOException