Package com.adyen.service.legalentitymanagement

Class TransferInstrumentsApi

java.lang.Object

com.adyen.Service

com.adyen.service.legalentitymanagement.TransferInstrumentsApi

public class TransferInstrumentsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
TransferInstrumentsApi(Client client)	Transfer instruments constructor in package.
TransferInstrumentsApi(Client client, String baseURL)	Transfer instruments constructor in package.

Method Summary

Modifier and Type	Method	Description
TransferInstrument	createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo)	Create a transfer instrument
TransferInstrument	createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo, RequestOptions requestOptions)	Create a transfer instrument
void	deleteTransferInstrument(String id)	Delete a transfer instrument
void	deleteTransferInstrument(String id, RequestOptions requestOptions)	Delete a transfer instrument
TransferInstrument	getTransferInstrument(String id)	Get a transfer instrument
TransferInstrument	getTransferInstrument(String id, RequestOptions requestOptions)	Get a transfer instrument
TransferInstrument	updateTransferInstrument(String id, TransferInstrumentInfo transferInstrumentInfo)	Update a transfer instrument
TransferInstrument	updateTransferInstrument(String id, TransferInstrumentInfo transferInstrumentInfo, RequestOptions requestOptions)	Update a transfer instrument

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

TransferInstrumentsApi

public TransferInstrumentsApi(Client client)

Transfer instruments constructor in package.

Parameters:

client - Client (required)

TransferInstrumentsApi

public TransferInstrumentsApi(Client client,
                              String baseURL)

Transfer instruments 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

createTransferInstrument

public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo)
                                            throws ApiException,
                                                   IOException

Create a transfer instrument

Parameters:

transferInstrumentInfo - TransferInstrumentInfo (required)

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException

createTransferInstrument

public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Create a transfer instrument

Parameters:

transferInstrumentInfo - TransferInstrumentInfo (required)

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

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException

deleteTransferInstrument

public void deleteTransferInstrument(String id)
                              throws ApiException,
                                     IOException

Delete a transfer instrument

Parameters:

id - String The unique identifier of the transfer instrument to be deleted. (required)

Throws:

ApiException - if fails to make API call

IOException

deleteTransferInstrument

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

Delete a transfer instrument

Parameters:

id - String The unique identifier of the transfer instrument to be deleted. (required)

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

Throws:

ApiException - if fails to make API call

IOException

getTransferInstrument

public TransferInstrument getTransferInstrument(String id)
                                         throws ApiException,
                                                IOException

Get a transfer instrument

Parameters:

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

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException

getTransferInstrument

public TransferInstrument getTransferInstrument(String id,
                                                RequestOptions requestOptions)
                                         throws ApiException,
                                                IOException

Get a transfer instrument

Parameters:

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

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

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException

updateTransferInstrument

public TransferInstrument updateTransferInstrument(String id,
                                                   TransferInstrumentInfo transferInstrumentInfo)
                                            throws ApiException,
                                                   IOException

Update a transfer instrument

Parameters:

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

transferInstrumentInfo - TransferInstrumentInfo (required)

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException

updateTransferInstrument

public TransferInstrument updateTransferInstrument(String id,
                                                   TransferInstrumentInfo transferInstrumentInfo,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Update a transfer instrument

Parameters:

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

transferInstrumentInfo - TransferInstrumentInfo (required)

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

Returns:

TransferInstrument

Throws:

ApiException - if fails to make API call

IOException