Package com.adyen.service.balanceplatform

Class TransactionRulesApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.TransactionRulesApi

public class TransactionRulesApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TransactionRulesApi(Client client)	Transaction rules constructor in package.
TransactionRulesApi(Client client, String baseURL)	Transaction rules constructor in package.

Method Summary

Modifier and Type	Method	Description
TransactionRule	createTransactionRule(TransactionRuleInfo transactionRuleInfo)	Create a transaction rule
TransactionRule	createTransactionRule(TransactionRuleInfo transactionRuleInfo, RequestOptions requestOptions)	Create a transaction rule
TransactionRule	deleteTransactionRule(String transactionRuleId)	Delete a transaction rule
TransactionRule	deleteTransactionRule(String transactionRuleId, RequestOptions requestOptions)	Delete a transaction rule
TransactionRuleResponse	getTransactionRule(String transactionRuleId)	Get a transaction rule
TransactionRuleResponse	getTransactionRule(String transactionRuleId, RequestOptions requestOptions)	Get a transaction rule
TransactionRule	updateTransactionRule(String transactionRuleId, TransactionRuleInfo transactionRuleInfo)	Update a transaction rule
TransactionRule	updateTransactionRule(String transactionRuleId, TransactionRuleInfo transactionRuleInfo, RequestOptions requestOptions)	Update a transaction rule

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

TransactionRulesApi

public TransactionRulesApi(Client client)

Transaction rules constructor in package.

Parameters:

client - Client (required)

TransactionRulesApi

public TransactionRulesApi(Client client,
                           String baseURL)

Transaction rules 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

createTransactionRule

public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo)
                                      throws ApiException,
                                             IOException

Create a transaction rule

Parameters:

transactionRuleInfo - TransactionRuleInfo (required)

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException

createTransactionRule

public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Create a transaction rule

Parameters:

transactionRuleInfo - TransactionRuleInfo (required)

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

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException

deleteTransactionRule

public TransactionRule deleteTransactionRule(String transactionRuleId)
                                      throws ApiException,
                                             IOException

Delete a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException

deleteTransactionRule

public TransactionRule deleteTransactionRule(String transactionRuleId,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Delete a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

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

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException

getTransactionRule

public TransactionRuleResponse getTransactionRule(String transactionRuleId)
                                           throws ApiException,
                                                  IOException

Get a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

Returns:

TransactionRuleResponse

Throws:

ApiException - if fails to make API call

IOException

getTransactionRule

public TransactionRuleResponse getTransactionRule(String transactionRuleId,
                                                  RequestOptions requestOptions)
                                           throws ApiException,
                                                  IOException

Get a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

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

Returns:

TransactionRuleResponse

Throws:

ApiException - if fails to make API call

IOException

updateTransactionRule

public TransactionRule updateTransactionRule(String transactionRuleId,
                                             TransactionRuleInfo transactionRuleInfo)
                                      throws ApiException,
                                             IOException

Update a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

transactionRuleInfo - TransactionRuleInfo (required)

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException

updateTransactionRule

public TransactionRule updateTransactionRule(String transactionRuleId,
                                             TransactionRuleInfo transactionRuleInfo,
                                             RequestOptions requestOptions)
                                      throws ApiException,
                                             IOException

Update a transaction rule

Parameters:

transactionRuleId - String The unique identifier of the transaction rule. (required)

transactionRuleInfo - TransactionRuleInfo (required)

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

Returns:

TransactionRule

Throws:

ApiException - if fails to make API call

IOException