Package com.adyen.service

Class PaymentsAppApi

java.lang.Object

com.adyen.Service

com.adyen.service.PaymentsAppApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public class PaymentsAppApi
extends Service

Deprecated, for removal: This API element is subject to removal in a future version.

Use instead com.adyen.service.paymentsapp.PaymentsAppApi

The service has been moved to a different package 'com.adyen.service.paymentsapp.PaymentsAppApi'

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	baseURL	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
PaymentsAppApi(Client client)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentsAppApi(Client client, String baseURL)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
BoardingTokenResponse	generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
BoardingTokenResponse	generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
BoardingTokenResponse	generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
BoardingTokenResponse	generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentsAppResponse	listPaymentsAppForMerchant(String merchantId)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentsAppResponse	listPaymentsAppForMerchant(String merchantId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentsAppResponse	listPaymentsAppForStore(String merchantId, String storeId)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentsAppResponse	listPaymentsAppForStore(String merchantId, String storeId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.
void	revokePaymentsApp(String merchantId, String installationId)	Deprecated, for removal: This API element is subject to removal in a future version.
void	revokePaymentsApp(String merchantId, String installationId, RequestOptions requestOptions)	Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

baseURL

protected String baseURL

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Detail

PaymentsAppApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppApi(Client client)

Deprecated, for removal: This API element is subject to removal in a future version.

Default constructor in package.

Parameters:

client - Client (required)

PaymentsAppApi

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppApi(Client client,
                      String baseURL)

Deprecated, for removal: This API element is subject to removal in a future version.

Alternative 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

generatePaymentsAppBoardingTokenForMerchant

@Deprecated(since="v37.0.0",
            forRemoval=true)
public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId,
                                                                         BoardingTokenRequest boardingTokenRequest)
                                                                  throws ApiException,
                                                                         IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a boarding token - merchant level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

boardingTokenRequest - BoardingTokenRequest (required)

boardingTokenRequest - BoardingTokenRequest (required)

Returns:

BoardingTokenResponse

Throws:

ApiException - if fails to make API call

IOException

generatePaymentsAppBoardingTokenForMerchant

@Deprecated(since="v37.0.0",
            forRemoval=true)
public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId,
                                                                         BoardingTokenRequest boardingTokenRequest,
                                                                         RequestOptions requestOptions)
                                                                  throws ApiException,
                                                                         IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a boarding token - merchant level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

boardingTokenRequest - BoardingTokenRequest (required)

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

Returns:

BoardingTokenResponse

Throws:

ApiException - if fails to make API call

IOException

generatePaymentsAppBoardingTokenForStore

@Deprecated(since="v37.0.0",
            forRemoval=true)
public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId,
                                                                      String storeId,
                                                                      BoardingTokenRequest boardingTokenRequest)
                                                               throws ApiException,
                                                                      IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a boarding token - store level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

storeId - String The unique identifier of the store. (required)

boardingTokenRequest - BoardingTokenRequest (required)

boardingTokenRequest - BoardingTokenRequest (required)

Returns:

BoardingTokenResponse

Throws:

ApiException - if fails to make API call

IOException

generatePaymentsAppBoardingTokenForStore

@Deprecated(since="v37.0.0",
            forRemoval=true)
public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId,
                                                                      String storeId,
                                                                      BoardingTokenRequest boardingTokenRequest,
                                                                      RequestOptions requestOptions)
                                                               throws ApiException,
                                                                      IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a boarding token - store level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

storeId - String The unique identifier of the store. (required)

boardingTokenRequest - BoardingTokenRequest (required)

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

Returns:

BoardingTokenResponse

Throws:

ApiException - if fails to make API call

IOException

listPaymentsAppForMerchant

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppResponse listPaymentsAppForMerchant(String merchantId)
                                               throws ApiException,
                                                      IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get a list of Payments Apps - merchant level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

Returns:

PaymentsAppResponse

Throws:

ApiException - if fails to make API call

IOException

listPaymentsAppForMerchant

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppResponse listPaymentsAppForMerchant(String merchantId,
                                                      String statuses,
                                                      Integer limit,
                                                      Long offset,
                                                      RequestOptions requestOptions)
                                               throws ApiException,
                                                      IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get a list of Payments Apps - merchant level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

statuses - String Query: The status of the Payments App. Comma-separated list of one or more values. If no value is provided, the list returns all statuses. Possible values: * **BOARDING** * **BOARDED** * **REVOKED** (optional)

limit - Integer Query: The number of items to return. (optional, default to 10)

offset - Long Query: The number of items to skip. (optional, default to 0)

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

Returns:

PaymentsAppResponse

Throws:

ApiException - if fails to make API call

IOException

listPaymentsAppForStore

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppResponse listPaymentsAppForStore(String merchantId,
                                                   String storeId)
                                            throws ApiException,
                                                   IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get a list of Payments Apps - store level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

storeId - String The unique identifier of the store. (required)

Returns:

PaymentsAppResponse

Throws:

ApiException - if fails to make API call

IOException

listPaymentsAppForStore

@Deprecated(since="v37.0.0",
            forRemoval=true)
public PaymentsAppResponse listPaymentsAppForStore(String merchantId,
                                                   String storeId,
                                                   String statuses,
                                                   Integer limit,
                                                   Long offset,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Get a list of Payments Apps - store level

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

storeId - String The unique identifier of the store. (required)

statuses - String Query: The status of the Payments App. Comma-separated list of one or more values. If no value is provided, the list returns all statuses. Possible values: * **BOARDING** * **BOARDED** * **REVOKED** (optional)

limit - Integer Query: The number of items to return. (optional, default to 10)

offset - Long Query: The number of items to skip. (optional, default to 0)

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

Returns:

PaymentsAppResponse

Throws:

ApiException - if fails to make API call

IOException

revokePaymentsApp

@Deprecated(since="v37.0.0",
            forRemoval=true)
public void revokePaymentsApp(String merchantId,
                              String installationId)
                       throws ApiException,
                              IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Revoke Payments App instance authentication

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

installationId - String The unique identifier of the Payments App instance on a device. (required)

Throws:

ApiException - if fails to make API call

IOException

revokePaymentsApp

@Deprecated(since="v37.0.0",
            forRemoval=true)
public void revokePaymentsApp(String merchantId,
                              String installationId,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Revoke Payments App instance authentication

Parameters:

merchantId - String The unique identifier of the merchant account. (required)

installationId - String The unique identifier of the Payments App instance on a device. (required)

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

Throws:

ApiException - if fails to make API call

IOException