Package com.adyen.service

Class PaymentsAppApi

java.lang.Object

com.adyen.Service

com.adyen.service.PaymentsAppApi

public class PaymentsAppApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
PaymentsAppApi(Client client)	Default constructor in package.
PaymentsAppApi(Client client, String baseURL)	Alternative constructor in package.

Method Summary

Modifier and Type	Method	Description
BoardingTokenResponse	generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest)	Create a boarding token - merchant level
BoardingTokenResponse	generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)	Create a boarding token - merchant level
BoardingTokenResponse	generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest)	Create a boarding token - store level
BoardingTokenResponse	generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)	Create a boarding token - store level
PaymentsAppResponse	listPaymentsAppForMerchant(String merchantId)	Get a list of Payments Apps - merchant level
PaymentsAppResponse	listPaymentsAppForMerchant(String merchantId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)	Get a list of Payments Apps - merchant level
PaymentsAppResponse	listPaymentsAppForStore(String merchantId, String storeId)	Get a list of Payments Apps - store level
PaymentsAppResponse	listPaymentsAppForStore(String merchantId, String storeId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)	Get a list of Payments Apps - store level
void	revokePaymentsApp(String merchantId, String installationId)	Revoke Payments App instance authentication
void	revokePaymentsApp(String merchantId, String installationId, RequestOptions requestOptions)	Revoke Payments App instance authentication

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

PaymentsAppApi

public PaymentsAppApi(Client client)

Default constructor in package.

Parameters:

client - Client (required)

PaymentsAppApi

public PaymentsAppApi(Client client,
                      String baseURL)

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

public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId,
                                                                         BoardingTokenRequest boardingTokenRequest)
                                                                  throws ApiException,
                                                                         IOException

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

public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId,
                                                                         BoardingTokenRequest boardingTokenRequest,
                                                                         RequestOptions requestOptions)
                                                                  throws ApiException,
                                                                         IOException

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

public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId,
                                                                      String storeId,
                                                                      BoardingTokenRequest boardingTokenRequest)
                                                               throws ApiException,
                                                                      IOException

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

public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId,
                                                                      String storeId,
                                                                      BoardingTokenRequest boardingTokenRequest,
                                                                      RequestOptions requestOptions)
                                                               throws ApiException,
                                                                      IOException

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

public PaymentsAppResponse listPaymentsAppForMerchant(String merchantId)
                                               throws ApiException,
                                                      IOException

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

public PaymentsAppResponse listPaymentsAppForMerchant(String merchantId,
                                                      String statuses,
                                                      Integer limit,
                                                      Long offset,
                                                      RequestOptions requestOptions)
                                               throws ApiException,
                                                      IOException

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

public PaymentsAppResponse listPaymentsAppForStore(String merchantId,
                                                   String storeId)
                                            throws ApiException,
                                                   IOException

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

public PaymentsAppResponse listPaymentsAppForStore(String merchantId,
                                                   String storeId,
                                                   String statuses,
                                                   Integer limit,
                                                   Long offset,
                                                   RequestOptions requestOptions)
                                            throws ApiException,
                                                   IOException

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

public void revokePaymentsApp(String merchantId,
                              String installationId)
                       throws ApiException,
                              IOException

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

public void revokePaymentsApp(String merchantId,
                              String installationId,
                              RequestOptions requestOptions)
                       throws ApiException,
                              IOException

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