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 StringAPI_VERSIONprotected StringbaseURL
-
Constructor Summary
Constructors Constructor Description PaymentsAppApi(Client client)Default constructor inpackage.PaymentsAppApi(Client client, String baseURL)Alternative constructor inpackage.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BoardingTokenResponsegeneratePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest)Create a boarding token - merchant levelBoardingTokenResponsegeneratePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)Create a boarding token - merchant levelBoardingTokenResponsegeneratePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest)Create a boarding token - store levelBoardingTokenResponsegeneratePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions)Create a boarding token - store levelPaymentsAppResponselistPaymentsAppForMerchant(String merchantId)Get a list of Payments Apps - merchant levelPaymentsAppResponselistPaymentsAppForMerchant(String merchantId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)Get a list of Payments Apps - merchant levelPaymentsAppResponselistPaymentsAppForStore(String merchantId, String storeId)Get a list of Payments Apps - store levelPaymentsAppResponselistPaymentsAppForStore(String merchantId, String storeId, String statuses, Integer limit, Long offset, RequestOptions requestOptions)Get a list of Payments Apps - store levelvoidrevokePaymentsApp(String merchantId, String installationId)Revoke Payments App instance authenticationvoidrevokePaymentsApp(String merchantId, String installationId, RequestOptions requestOptions)Revoke Payments App instance authentication-
Methods inherited from class com.adyen.Service
createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient
-
-
-
-
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 inpackage.- Parameters:
client-Client(required)
-
-
Method Detail
-
generatePaymentsAppBoardingTokenForMerchant
public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest) throws ApiException, IOException
Create a boarding token - merchant level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)boardingTokenRequest-BoardingTokenRequest(required)boardingTokenRequest-BoardingTokenRequest(required)- Returns:
BoardingTokenResponse- Throws:
ApiException- if fails to make API callIOException
-
generatePaymentsAppBoardingTokenForMerchant
public BoardingTokenResponse generatePaymentsAppBoardingTokenForMerchant(String merchantId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions) throws ApiException, IOException
Create a boarding token - merchant level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)boardingTokenRequest-BoardingTokenRequest(required)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
BoardingTokenResponse- Throws:
ApiException- if fails to make API callIOException
-
generatePaymentsAppBoardingTokenForStore
public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest) throws ApiException, IOException
Create a boarding token - store level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)storeId-StringThe unique identifier of the store. (required)boardingTokenRequest-BoardingTokenRequest(required)boardingTokenRequest-BoardingTokenRequest(required)- Returns:
BoardingTokenResponse- Throws:
ApiException- if fails to make API callIOException
-
generatePaymentsAppBoardingTokenForStore
public BoardingTokenResponse generatePaymentsAppBoardingTokenForStore(String merchantId, String storeId, BoardingTokenRequest boardingTokenRequest, RequestOptions requestOptions) throws ApiException, IOException
Create a boarding token - store level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)storeId-StringThe unique identifier of the store. (required)boardingTokenRequest-BoardingTokenRequest(required)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
BoardingTokenResponse- Throws:
ApiException- if fails to make API callIOException
-
listPaymentsAppForMerchant
public PaymentsAppResponse listPaymentsAppForMerchant(String merchantId) throws ApiException, IOException
Get a list of Payments Apps - merchant level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)- Returns:
PaymentsAppResponse- Throws:
ApiException- if fails to make API callIOException
-
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-StringThe unique identifier of the merchant account. (required)statuses-StringQuery: 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-IntegerQuery: The number of items to return. (optional, default to 10)offset-LongQuery: The number of items to skip. (optional, default to 0)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
PaymentsAppResponse- Throws:
ApiException- if fails to make API callIOException
-
listPaymentsAppForStore
public PaymentsAppResponse listPaymentsAppForStore(String merchantId, String storeId) throws ApiException, IOException
Get a list of Payments Apps - store level- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)storeId-StringThe unique identifier of the store. (required)- Returns:
PaymentsAppResponse- Throws:
ApiException- if fails to make API callIOException
-
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-StringThe unique identifier of the merchant account. (required)storeId-StringThe unique identifier of the store. (required)statuses-StringQuery: 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-IntegerQuery: The number of items to return. (optional, default to 10)offset-LongQuery: The number of items to skip. (optional, default to 0)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Returns:
PaymentsAppResponse- Throws:
ApiException- if fails to make API callIOException
-
revokePaymentsApp
public void revokePaymentsApp(String merchantId, String installationId) throws ApiException, IOException
Revoke Payments App instance authentication- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)installationId-StringThe unique identifier of the Payments App instance on a device. (required)- Throws:
ApiException- if fails to make API callIOException
-
revokePaymentsApp
public void revokePaymentsApp(String merchantId, String installationId, RequestOptions requestOptions) throws ApiException, IOException
Revoke Payments App instance authentication- Parameters:
merchantId-StringThe unique identifier of the merchant account. (required)installationId-StringThe unique identifier of the Payments App instance on a device. (required)requestOptions-RequestOptionsObject to store additional data such as idempotency-keys (optional)- Throws:
ApiException- if fails to make API callIOException
-
-