Package com.adyen.service.balanceplatform

Class PaymentInstrumentGroupsApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.PaymentInstrumentGroupsApi

public class PaymentInstrumentGroupsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentInstrumentGroupsApi(Client client)	Payment instrument groups constructor in package.
PaymentInstrumentGroupsApi(Client client, String baseURL)	Payment instrument groups constructor in package.

Method Summary

Modifier and Type	Method	Description
PaymentInstrumentGroup	createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo)	Create a payment instrument group
PaymentInstrumentGroup	createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo, RequestOptions requestOptions)	Create a payment instrument group
TransactionRulesResponse	getAllTransactionRulesForPaymentInstrumentGroup(String id)	Get all transaction rules for a payment instrument group
TransactionRulesResponse	getAllTransactionRulesForPaymentInstrumentGroup(String id, RequestOptions requestOptions)	Get all transaction rules for a payment instrument group
PaymentInstrumentGroup	getPaymentInstrumentGroup(String id)	Get a payment instrument group
PaymentInstrumentGroup	getPaymentInstrumentGroup(String id, RequestOptions requestOptions)	Get a payment instrument group

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

PaymentInstrumentGroupsApi

public PaymentInstrumentGroupsApi(Client client)

Payment instrument groups constructor in package.

Parameters:

client - Client (required)

PaymentInstrumentGroupsApi

public PaymentInstrumentGroupsApi(Client client,
                                  String baseURL)

Payment instrument groups 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

createPaymentInstrumentGroup

public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo)
                                                    throws ApiException,
                                                           IOException

Create a payment instrument group

Parameters:

paymentInstrumentGroupInfo - PaymentInstrumentGroupInfo (required)

Returns:

PaymentInstrumentGroup

Throws:

ApiException - if fails to make API call

IOException

createPaymentInstrumentGroup

public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo,
                                                           RequestOptions requestOptions)
                                                    throws ApiException,
                                                           IOException

Create a payment instrument group

Parameters:

paymentInstrumentGroupInfo - PaymentInstrumentGroupInfo (required)

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

Returns:

PaymentInstrumentGroup

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForPaymentInstrumentGroup

public TransactionRulesResponse getAllTransactionRulesForPaymentInstrumentGroup(String id)
                                                                         throws ApiException,
                                                                                IOException

Get all transaction rules for a payment instrument group

Parameters:

id - String The unique identifier of the payment instrument group. (required)

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForPaymentInstrumentGroup

public TransactionRulesResponse getAllTransactionRulesForPaymentInstrumentGroup(String id,
                                                                                RequestOptions requestOptions)
                                                                         throws ApiException,
                                                                                IOException

Get all transaction rules for a payment instrument group

Parameters:

id - String The unique identifier of the payment instrument group. (required)

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

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrumentGroup

public PaymentInstrumentGroup getPaymentInstrumentGroup(String id)
                                                 throws ApiException,
                                                        IOException

Get a payment instrument group

Parameters:

id - String The unique identifier of the payment instrument group. (required)

Returns:

PaymentInstrumentGroup

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrumentGroup

public PaymentInstrumentGroup getPaymentInstrumentGroup(String id,
                                                        RequestOptions requestOptions)
                                                 throws ApiException,
                                                        IOException

Get a payment instrument group

Parameters:

id - String The unique identifier of the payment instrument group. (required)

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

Returns:

PaymentInstrumentGroup

Throws:

ApiException - if fails to make API call

IOException