Package com.adyen.service.balanceplatform

Class PaymentInstrumentsApi

java.lang.Object

com.adyen.Service

com.adyen.service.balanceplatform.PaymentInstrumentsApi

public class PaymentInstrumentsApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentInstrumentsApi(Client client)	Payment instruments constructor in package.
PaymentInstrumentsApi(Client client, String baseURL)	Payment instruments constructor in package.

Method Summary

Modifier and Type	Method	Description
PaymentInstrument	createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo)	Create a payment instrument
PaymentInstrument	createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo, RequestOptions requestOptions)	Create a payment instrument
TransactionRulesResponse	getAllTransactionRulesForPaymentInstrument(String id)	Get all transaction rules for a payment instrument
TransactionRulesResponse	getAllTransactionRulesForPaymentInstrument(String id, RequestOptions requestOptions)	Get all transaction rules for a payment instrument
PaymentInstrumentRevealInfo	getPanOfPaymentInstrument(String id)	Get the PAN of a payment instrument
PaymentInstrumentRevealInfo	getPanOfPaymentInstrument(String id, RequestOptions requestOptions)	Get the PAN of a payment instrument
PaymentInstrument	getPaymentInstrument(String id)	Get a payment instrument
PaymentInstrument	getPaymentInstrument(String id, RequestOptions requestOptions)	Get a payment instrument
ListNetworkTokensResponse	listNetworkTokens(String id)	List network tokens
ListNetworkTokensResponse	listNetworkTokens(String id, RequestOptions requestOptions)	List network tokens
PaymentInstrumentRevealResponse	revealDataOfPaymentInstrument(PaymentInstrumentRevealRequest paymentInstrumentRevealRequest)	Reveal the data of a payment instrument
PaymentInstrumentRevealResponse	revealDataOfPaymentInstrument(PaymentInstrumentRevealRequest paymentInstrumentRevealRequest, RequestOptions requestOptions)	Reveal the data of a payment instrument
UpdatePaymentInstrument	updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest)	Update a payment instrument
UpdatePaymentInstrument	updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest, RequestOptions requestOptions)	Update a payment 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

PaymentInstrumentsApi

public PaymentInstrumentsApi(Client client)

Payment instruments constructor in package.

Parameters:

client - Client (required)

PaymentInstrumentsApi

public PaymentInstrumentsApi(Client client,
                             String baseURL)

Payment 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

createPaymentInstrument

public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo)
                                          throws ApiException,
                                                 IOException

Create a payment instrument

Parameters:

paymentInstrumentInfo - PaymentInstrumentInfo (required)

Returns:

PaymentInstrument

Throws:

ApiException - if fails to make API call

IOException

createPaymentInstrument

public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo,
                                                 RequestOptions requestOptions)
                                          throws ApiException,
                                                 IOException

Create a payment instrument

Parameters:

paymentInstrumentInfo - PaymentInstrumentInfo (required)

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

Returns:

PaymentInstrument

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForPaymentInstrument

public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(String id)
                                                                    throws ApiException,
                                                                           IOException

Get all transaction rules for a payment instrument

Parameters:

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

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getAllTransactionRulesForPaymentInstrument

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

Get all transaction rules for a payment instrument

Parameters:

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

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

Returns:

TransactionRulesResponse

Throws:

ApiException - if fails to make API call

IOException

getPanOfPaymentInstrument

public PaymentInstrumentRevealInfo getPanOfPaymentInstrument(String id)
                                                      throws ApiException,
                                                             IOException

Get the PAN of a payment instrument

Parameters:

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

Returns:

PaymentInstrumentRevealInfo

Throws:

ApiException - if fails to make API call

IOException

getPanOfPaymentInstrument

public PaymentInstrumentRevealInfo getPanOfPaymentInstrument(String id,
                                                             RequestOptions requestOptions)
                                                      throws ApiException,
                                                             IOException

Get the PAN of a payment instrument

Parameters:

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

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

Returns:

PaymentInstrumentRevealInfo

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrument

public PaymentInstrument getPaymentInstrument(String id)
                                       throws ApiException,
                                              IOException

Get a payment instrument

Parameters:

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

Returns:

PaymentInstrument

Throws:

ApiException - if fails to make API call

IOException

getPaymentInstrument

public PaymentInstrument getPaymentInstrument(String id,
                                              RequestOptions requestOptions)
                                       throws ApiException,
                                              IOException

Get a payment instrument

Parameters:

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

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

Returns:

PaymentInstrument

Throws:

ApiException - if fails to make API call

IOException

listNetworkTokens

public ListNetworkTokensResponse listNetworkTokens(String id)
                                            throws ApiException,
                                                   IOException

List network tokens

Parameters:

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

Returns:

ListNetworkTokensResponse

Throws:

ApiException - if fails to make API call

IOException

listNetworkTokens

public ListNetworkTokensResponse listNetworkTokens(String id,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

List network tokens

Parameters:

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

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

Returns:

ListNetworkTokensResponse

Throws:

ApiException - if fails to make API call

IOException

revealDataOfPaymentInstrument

public PaymentInstrumentRevealResponse revealDataOfPaymentInstrument(PaymentInstrumentRevealRequest paymentInstrumentRevealRequest)
                                                              throws ApiException,
                                                                     IOException

Reveal the data of a payment instrument

Parameters:

paymentInstrumentRevealRequest - PaymentInstrumentRevealRequest (required)

Returns:

PaymentInstrumentRevealResponse

Throws:

ApiException - if fails to make API call

IOException

revealDataOfPaymentInstrument

public PaymentInstrumentRevealResponse revealDataOfPaymentInstrument(PaymentInstrumentRevealRequest paymentInstrumentRevealRequest,
                                                                     RequestOptions requestOptions)
                                                              throws ApiException,
                                                                     IOException

Reveal the data of a payment instrument

Parameters:

paymentInstrumentRevealRequest - PaymentInstrumentRevealRequest (required)

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

Returns:

PaymentInstrumentRevealResponse

Throws:

ApiException - if fails to make API call

IOException

updatePaymentInstrument

public UpdatePaymentInstrument updatePaymentInstrument(String id,
                                                       PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest)
                                                throws ApiException,
                                                       IOException

Update a payment instrument

Parameters:

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

paymentInstrumentUpdateRequest - PaymentInstrumentUpdateRequest (required)

Returns:

UpdatePaymentInstrument

Throws:

ApiException - if fails to make API call

IOException

updatePaymentInstrument

public UpdatePaymentInstrument updatePaymentInstrument(String id,
                                                       PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest,
                                                       RequestOptions requestOptions)
                                                throws ApiException,
                                                       IOException

Update a payment instrument

Parameters:

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

paymentInstrumentUpdateRequest - PaymentInstrumentUpdateRequest (required)

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

Returns:

UpdatePaymentInstrument

Throws:

ApiException - if fails to make API call

IOException