com.amazon.pay.api

Class AmazonPayClient

java.lang.Object

com.amazon.pay.api.AmazonPayClient

Direct Known Subclasses:

InstoreClient, WebstoreClient

public class AmazonPayClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.impl.conn.PoolingHttpClientConnectionManager	connectionManager
protected PayConfiguration	payConfiguration
protected RequestSigner	requestSigner

Constructor Summary

Constructors

Constructor and Description
AmazonPayClient(PayConfiguration payConfiguration)

Method Summary

Modifier and Type	Method and Description
AmazonPayResponse	callAPI(URI uri, String httpMethodName, Map<String,List<String>> queryParameters, String request, Map<String,String> header) API to process the request and return the
AmazonPayResponse	deleteAmazonPayAccount(String merchantAccountId)
AmazonPayResponse	deleteAmazonPayAccount(String merchantAccountId, Map<String,String> header) Deletes the Merchant account for the given Merchant Account ID.
AmazonPayResponse	deliveryTracker(org.json.JSONObject payload) The Delivery Tracker operation is used to track the delivery status
AmazonPayResponse	deliveryTracker(org.json.JSONObject payload, Map<String,String> header) The Delivery Tracker operation is used to track the delivery status
String	generateButtonSignature(org.json.JSONObject payload) generateButtonSignature is a convenience method to assist the developer in generating static signatures that can be used by Checkout v2's amazon.Pay.renderButton method.
String	generateButtonSignature(String payload) generateButtonSignature is a convenience method to assist the developer in generating static signatures that can be used by Checkout v2's amazon.Pay.renderButton method.
AmazonPayResponse	getAuthorizationToken(String mwsAuthToken, String merchantId, Map<String,String> header) The get Authorization Token operation is used to obtain retrieve a delegated authorization token used in order to make API calls on behalf of a merchant.
protected org.apache.http.impl.client.CloseableHttpClient	getClosableHttpClientWithConnectionPool() Returns the CloseableHttpClient object with Connection Pool based on the Payconfiguration
protected org.apache.http.impl.client.CloseableHttpClient	getClosableHttpClientWithPoolAndProxy() Returns the CloseableHttpClient object with Connection Pool based on the given proxy settings.
ConnectionPoolStats	getPoolStats() Helper function to retrieve the Connection Pool Stats to the caller to monitor the Connection Pool Performance
AmazonPayResponse	registerAmazonPayAccount(org.json.JSONObject payload)
AmazonPayResponse	registerAmazonPayAccount(org.json.JSONObject payload, Map<String,String> header) Creates a non-logginable account for your merchant partners.
AmazonPayResponse	updateAmazonPayAccount(String merchantAccountId, org.json.JSONObject payload)
AmazonPayResponse	updateAmazonPayAccount(String merchantAccountId, org.json.JSONObject payload, Map<String,String> header) Updates a merchant account for the given Merchant Account ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

payConfiguration

protected final PayConfiguration payConfiguration

requestSigner

protected final RequestSigner requestSigner

connectionManager

protected final org.apache.http.impl.conn.PoolingHttpClientConnectionManager connectionManager

Constructor Detail

AmazonPayClient

public AmazonPayClient(PayConfiguration payConfiguration)
                throws AmazonPayClientException

Throws:

AmazonPayClientException

Method Detail

deliveryTracker

public AmazonPayResponse deliveryTracker(org.json.JSONObject payload,
                                         Map<String,String> header)
                                  throws AmazonPayClientException

The Delivery Tracker operation is used to track the delivery status

Parameters:

payload - JSONObject request body

header - Map<String, String> containining key-value pair of required headers (e.g., keys such as x-amz-pay-idempotency-key, x-amz-pay-authtoken)

Returns:

The response from the deliveryTracker service API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

getAuthorizationToken

public AmazonPayResponse getAuthorizationToken(String mwsAuthToken,
                                               String merchantId,
                                               Map<String,String> header)
                                        throws AmazonPayClientException

The get Authorization Token operation is used to obtain retrieve a delegated authorization token used in order to make API calls on behalf of a merchant. This token is needed to make delegated calls. Important: getAuthorizationToken() requires a Client configured to use the live environment.

Parameters:

mwsAuthToken - MWS Authorization Token previously shared by Merchant to the Solution Provider

merchantId - Merchant ID that generated the MWS Authorization Token

header - Map<String, String> containining key-value pair of required headers (e.g., keys such as x-amz-pay-idempotency-key, x-amz-pay-authtoken)

Returns:

The response from the getAuthorizationToken service API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

See Also:

AmazonPayClient, PayConfiguration, Environment

deliveryTracker

public AmazonPayResponse deliveryTracker(org.json.JSONObject payload)
                                  throws AmazonPayClientException

The Delivery Tracker operation is used to track the delivery status

Parameters:

payload - JSONObject request body

Returns:

The response from the deliveryTracker service API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

generateButtonSignature

public String generateButtonSignature(org.json.JSONObject payload)
                               throws AmazonPayClientException

generateButtonSignature is a convenience method to assist the developer in generating static signatures that can be used by Checkout v2's amazon.Pay.renderButton method. Unlike API call signatures, the system timestamp is not part of the signing logic, so these signatures do not expire.

Parameters:

payload - The payloadJSON attribute from createCheckoutSessionConfig object used by amazon.Pay.renderButton method from checkout.js

Returns:

String signature attribute value for createCheckoutSessionConfig object on your website frontend

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

generateButtonSignature

public String generateButtonSignature(String payload)
                               throws AmazonPayClientException

generateButtonSignature is a convenience method to assist the developer in generating static signatures that can be used by Checkout v2's amazon.Pay.renderButton method. Unlike API call signatures, the system timestamp is not part of the signing logic, so these signatures do not expire.

Parameters:

payload - The payloadJSON attribute from createCheckoutSessionConfig object used by amazon.Pay.renderButton method from checkout.js

Returns:

String signature attribute value for createCheckoutSessionConfig object on your website frontend

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

callAPI

public AmazonPayResponse callAPI(URI uri,
                                 String httpMethodName,
                                 Map<String,List<String>> queryParameters,
                                 String request,
                                 Map<String,String> header)
                          throws AmazonPayClientException

API to process the request and return the

Parameters:

uri - The uri that needs to be executed

httpMethodName - the HTTP request method(GET,PUT,POST etc) to be used

queryParameters - the query parameters map

request - the payload to be sent with the request

header - the header of the solution provider

Returns:

response of type AmazonPayResponse

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue

getPoolStats

public ConnectionPoolStats getPoolStats()

Helper function to retrieve the Connection Pool Stats to the caller to monitor the Connection Pool Performance

Returns:

a ConnectionPoolStats of the Connection Pool

getClosableHttpClientWithConnectionPool

protected org.apache.http.impl.client.CloseableHttpClient getClosableHttpClientWithConnectionPool()

Returns the CloseableHttpClient object with Connection Pool based on the Payconfiguration

Returns:

the CloseableHttpClient

getClosableHttpClientWithPoolAndProxy

protected org.apache.http.impl.client.CloseableHttpClient getClosableHttpClientWithPoolAndProxy()

Returns the CloseableHttpClient object with Connection Pool based on the given proxy settings.

Returns:

the CloseableHttpClient

registerAmazonPayAccount

public AmazonPayResponse registerAmazonPayAccount(org.json.JSONObject payload,
                                                  Map<String,String> header)
                                           throws AmazonPayClientException

Creates a non-logginable account for your merchant partners. These would be special accounts through which Merchants would not be able to login to Amazon or access Seller Central.

Parameters:

payload - JSONObject request body

header - Map<String, String> containing key-value pair of required headers (e.g., keys such as x-amz-pay-idempotency-key, x-amz-pay-authtoken).

Returns:

The response from registerAmazonPayAccount API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue.

registerAmazonPayAccount

public AmazonPayResponse registerAmazonPayAccount(org.json.JSONObject payload)
                                           throws AmazonPayClientException

Throws:

AmazonPayClientException

updateAmazonPayAccount

public AmazonPayResponse updateAmazonPayAccount(String merchantAccountId,
                                                org.json.JSONObject payload,
                                                Map<String,String> header)
                                         throws AmazonPayClientException

Updates a merchant account for the given Merchant Account ID. We would be allowing our partners to update only a certain set of fields which won’t change the legal business entity itself.

Parameters:

merchantAccountId - Internal Merchant Account ID provided while calling the API.

payload - JSONObject request body

header - Map<String, String> containing key-value pair of required headers (e.g., keys such as x-amz-pay-idempotency-key, x-amz-pay-authtoken).

Returns:

The response from updateAmazonPayAccount API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue.

updateAmazonPayAccount

public AmazonPayResponse updateAmazonPayAccount(String merchantAccountId,
                                                org.json.JSONObject payload)
                                         throws AmazonPayClientException

Throws:

AmazonPayClientException

deleteAmazonPayAccount

public AmazonPayResponse deleteAmazonPayAccount(String merchantAccountId,
                                                Map<String,String> header)
                                         throws AmazonPayClientException

Deletes the Merchant account for the given Merchant Account ID. Partners can close the merchant accounts created for their merchant partners.

Parameters:

merchantAccountId - Internal Merchant Account ID provided while calling the API.

header - Map<String, String> containing key-value pair of required headers (e.g., keys such as x-amz-pay-idempotency-key, x-amz-pay-authtoken).

Returns:

The response from deleteAmazonPayAccount API, as returned by Amazon Pay.

Throws:

AmazonPayClientException - When an error response is returned by Amazon Pay due to bad request or other issue.

deleteAmazonPayAccount

public AmazonPayResponse deleteAmazonPayAccount(String merchantAccountId)
                                         throws AmazonPayClientException

Throws:

AmazonPayClientException