com.amazon.pay.api

Class WebstoreClient

java.lang.Object

com.amazon.pay.api.AmazonPayClient

com.amazon.pay.api.WebstoreClient

public class WebstoreClient
extends AmazonPayClient

Field Summary

Fields inherited from class com.amazon.pay.api.AmazonPayClient

payConfiguration, requestSigner

Constructor Summary

Constructors

Constructor and Description
WebstoreClient(PayConfiguration payConfiguration)

Method Summary

Modifier and Type	Method and Description
AmazonPayResponse	cancelCharge(String chargeId, net.sf.json.JSONObject payload) The cancelCharge operation is used to cancel Charges.
AmazonPayResponse	cancelCharge(String chargeId, net.sf.json.JSONObject payload, Map<String,String> header) The cancelCharge operation is used to cancel Charges.
AmazonPayResponse	captureCharge(String chargeId, net.sf.json.JSONObject payload) The CaptureCharge operation is used to create a charges for a buyer and pass the Id as part of button click.
AmazonPayResponse	captureCharge(String chargeId, net.sf.json.JSONObject payload, Map<String,String> header) The CaptureCharge operation is used to create a charges for a buyer and pass the Id as part of button click.
AmazonPayResponse	closeChargePermission(String chargePermissionId, net.sf.json.JSONObject payload) The CloseChargePermission operation Moves the Charge Permission to a Closed state.
AmazonPayResponse	closeChargePermission(String chargePermissionId, net.sf.json.JSONObject payload, Map<String,String> header) The CloseChargePermission operation Moves the Charge Permission to a Closed state.
AmazonPayResponse	completeCheckoutSession(String checkoutSessionId, net.sf.json.JSONObject payload) The CompleteCheckoutSession operation is used to confirm completion of a checkout session.
AmazonPayResponse	completeCheckoutSession(String checkoutSessionId, net.sf.json.JSONObject payload, Map<String,String> header) The CompleteCheckoutSession operation is used to confirm completion of a checkout session
AmazonPayResponse	createCharge(net.sf.json.JSONObject payload) The CreateCharge operation is used to create a charges for a buyer and pass the Id as part of button click.
AmazonPayResponse	createCharge(net.sf.json.JSONObject payload, Map<String,String> header) The CreateCharge operation is used to create a charges for a buyer and pass the Id as part of button click.
AmazonPayResponse	createCheckoutSession(net.sf.json.JSONObject payload) The CreateCheckoutSession operation is used to create a CheckoutSession for a buyer and pass the Id as part of button click.
AmazonPayResponse	createCheckoutSession(net.sf.json.JSONObject payload, Map<String,String> header) The CreateCheckoutSession operation is used to create a CheckoutSession for a buyer and pass the Id as part of button click.
AmazonPayResponse	createRefund(net.sf.json.JSONObject payload) The CreateRefund operation is used to create a refund for a buyer and pass the Id as part of button click.
AmazonPayResponse	createRefund(net.sf.json.JSONObject payload, Map<String,String> header) The CreateRefund operation is used to create a refund for a buyer and pass the Id as part of button click.
AmazonPayResponse	getBuyer(String buyerToken) Get Buyer details can include buyer ID, name, email address, postal code, and country code when used with the Amazon.Pay.renderButton 'SignIn' productType and corresponding signInScopes.
AmazonPayResponse	getBuyer(String buyerToken, Map<String,String> header) Get Buyer details can include buyer ID, name, email address, postal code, and country code when used with the Amazon.Pay.renderButton 'SignIn' productType and corresponding signInScopes.
AmazonPayResponse	getCharge(String chargeId) The getCharge operation is used to get charges details that contain
AmazonPayResponse	getCharge(String chargeId, Map<String,String> header) The getCharge operation is used to get charges details that contain
AmazonPayResponse	getChargePermission(String chargePermissionId) The GetChargePermission operation is used to get the complete details of ChargePermission.
AmazonPayResponse	getChargePermission(String chargePermissionId, Map<String,String> header) The GetChargePermission operation is used to get the complete details of ChargePermission.
AmazonPayResponse	getCheckoutSession(String checkoutSessionId) The GetCheckoutSession operation is used to get checkout session details that contain all session associated details.
AmazonPayResponse	getCheckoutSession(String checkoutSessionId, Map<String,String> header) The GetCheckoutSession operation is used to get checkout session details that contain all session associated details.
AmazonPayResponse	getRefund(String refundId) The getRefund operation is used to get refund details that contain
AmazonPayResponse	getRefund(String refundId, Map<String,String> header) The getRefund operation is used to get refund details that contain
AmazonPayResponse	updateChargePermission(String chargePermissionId, net.sf.json.JSONObject payload) The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
AmazonPayResponse	updateChargePermission(String chargePermissionId, net.sf.json.JSONObject payload, Map<String,String> header) The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
AmazonPayResponse	updateCheckoutSession(String checkoutSessionId, net.sf.json.JSONObject payload) The UpdateCheckoutSession operation is used to update payment details for a session.
AmazonPayResponse	updateCheckoutSession(String checkoutSessionId, net.sf.json.JSONObject payload, Map<String,String> header) The UpdateCheckoutSession operation is used to update payment details for a session.

Methods inherited from class com.amazon.pay.api.AmazonPayClient

callAPI, deliveryTracker, deliveryTracker, generateButtonSignature, generateButtonSignature, getAuthorizationToken

Methods inherited from class java.lang.Object

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

Constructor Detail

WebstoreClient

public WebstoreClient(PayConfiguration payConfiguration)
               throws AmazonPayClientException

Throws:

AmazonPayClientException

Method Detail

getBuyer

public AmazonPayResponse getBuyer(String buyerToken,
                                  Map<String,String> header)
                           throws AmazonPayClientException

Get Buyer details can include buyer ID, name, email address, postal code, and country code when used with the Amazon.Pay.renderButton 'SignIn' productType and corresponding signInScopes.

Parameters:

buyerToken - Buyer 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 GetBuyer 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

getBuyer

public AmazonPayResponse getBuyer(String buyerToken)
                           throws AmazonPayClientException

Get Buyer details can include buyer ID, name, email address, postal code, and country code when used with the Amazon.Pay.renderButton 'SignIn' productType and corresponding signInScopes.

Parameters:

buyerToken - Buyer Token

Returns:

The response from the GetBuyer 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

createCheckoutSession

public AmazonPayResponse createCheckoutSession(net.sf.json.JSONObject payload,
                                               Map<String,String> header)
                                        throws AmazonPayClientException

The CreateCheckoutSession operation is used to create a CheckoutSession for a buyer and pass the Id as part of button click.

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 CreateCheckoutSession 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

createCheckoutSession

public AmazonPayResponse createCheckoutSession(net.sf.json.JSONObject payload)
                                        throws AmazonPayClientException

The CreateCheckoutSession operation is used to create a CheckoutSession for a buyer and pass the Id as part of button click.

Parameters:

payload - JSONObject request body

Returns:

The response from the CreateCheckoutSession 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

getCheckoutSession

public AmazonPayResponse getCheckoutSession(String checkoutSessionId,
                                            Map<String,String> header)
                                     throws AmazonPayClientException

The GetCheckoutSession operation is used to get checkout session details that contain all session associated details.

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

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 GetCheckoutSession 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

getCheckoutSession

public AmazonPayResponse getCheckoutSession(String checkoutSessionId)
                                     throws AmazonPayClientException

The GetCheckoutSession operation is used to get checkout session details that contain all session associated details.

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

Returns:

The response from the GetCheckoutSession 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

updateCheckoutSession

public AmazonPayResponse updateCheckoutSession(String checkoutSessionId,
                                               net.sf.json.JSONObject payload,
                                               Map<String,String> header)
                                        throws AmazonPayClientException

The UpdateCheckoutSession operation is used to update payment details for a session.

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

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 UpdateCheckoutSession 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

updateCheckoutSession

public AmazonPayResponse updateCheckoutSession(String checkoutSessionId,
                                               net.sf.json.JSONObject payload)
                                        throws AmazonPayClientException

The UpdateCheckoutSession operation is used to update payment details for a session.

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the UpdateCheckoutSession 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

completeCheckoutSession

public AmazonPayResponse completeCheckoutSession(String checkoutSessionId,
                                                 net.sf.json.JSONObject payload,
                                                 Map<String,String> header)
                                          throws AmazonPayClientException

The CompleteCheckoutSession operation is used to confirm completion of a checkout session

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

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 CompleteCheckoutSession 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

completeCheckoutSession

public AmazonPayResponse completeCheckoutSession(String checkoutSessionId,
                                                 net.sf.json.JSONObject payload)
                                          throws AmazonPayClientException

The CompleteCheckoutSession operation is used to confirm completion of a checkout session.

Parameters:

checkoutSessionId - Checkout Session ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the CompleteCheckoutSession 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

getChargePermission

public AmazonPayResponse getChargePermission(String chargePermissionId,
                                             Map<String,String> header)
                                      throws AmazonPayClientException

The GetChargePermission operation is used to get the complete details of ChargePermission.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

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 GetChargePermission 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

getChargePermission

public AmazonPayResponse getChargePermission(String chargePermissionId)
                                      throws AmazonPayClientException

The GetChargePermission operation is used to get the complete details of ChargePermission.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

Returns:

The response from the GetChargePermission 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

updateChargePermission

public AmazonPayResponse updateChargePermission(String chargePermissionId,
                                                net.sf.json.JSONObject payload,
                                                Map<String,String> header)
                                         throws AmazonPayClientException

The UpdateChargePermission operation is used to update the metadata of the ChargePermission.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

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 UpdateChargePermission 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

updateChargePermission

public AmazonPayResponse updateChargePermission(String chargePermissionId,
                                                net.sf.json.JSONObject payload)
                                         throws AmazonPayClientException

The UpdateChargePermission operation is used to update the metadata of the ChargePermission.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the UpdateChargePermission 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

closeChargePermission

public AmazonPayResponse closeChargePermission(String chargePermissionId,
                                               net.sf.json.JSONObject payload,
                                               Map<String,String> header)
                                        throws AmazonPayClientException

The CloseChargePermission operation Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

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 CloseChargePermission 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

closeChargePermission

public AmazonPayResponse closeChargePermission(String chargePermissionId,
                                               net.sf.json.JSONObject payload)
                                        throws AmazonPayClientException

The CloseChargePermission operation Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.

Parameters:

chargePermissionId - Charge Permission ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the CloseChargePermission 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

createCharge

public AmazonPayResponse createCharge(net.sf.json.JSONObject payload,
                                      Map<String,String> header)
                               throws AmazonPayClientException

The CreateCharge operation is used to create a charges for a buyer and pass the Id as part of button click.

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 CreateCharge 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

createCharge

public AmazonPayResponse createCharge(net.sf.json.JSONObject payload)
                               throws AmazonPayClientException

The CreateCharge operation is used to create a charges for a buyer and pass the Id as part of button click.

Parameters:

payload - JSONObject request body

Returns:

The response from the CreateCharge 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

getCharge

public AmazonPayResponse getCharge(String chargeId,
                                   Map<String,String> header)
                            throws AmazonPayClientException

The getCharge operation is used to get charges details that contain

Parameters:

chargeId - Charge ID provided by Checkout v2 service

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 getCharge 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

getCharge

public AmazonPayResponse getCharge(String chargeId)
                            throws AmazonPayClientException

The getCharge operation is used to get charges details that contain

Parameters:

chargeId - Charge ID provided by Checkout v2 service

Returns:

The response from the getCharge 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

captureCharge

public AmazonPayResponse captureCharge(String chargeId,
                                       net.sf.json.JSONObject payload,
                                       Map<String,String> header)
                                throws AmazonPayClientException

The CaptureCharge operation is used to create a charges for a buyer and pass the Id as part of button click.

Parameters:

chargeId - Charge ID provided by Checkout v2 service

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 CaptureCharge 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

captureCharge

public AmazonPayResponse captureCharge(String chargeId,
                                       net.sf.json.JSONObject payload)
                                throws AmazonPayClientException

The CaptureCharge operation is used to create a charges for a buyer and pass the Id as part of button click.

Parameters:

chargeId - Charge ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the CaptureCharge 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

cancelCharge

public AmazonPayResponse cancelCharge(String chargeId,
                                      net.sf.json.JSONObject payload,
                                      Map<String,String> header)
                               throws AmazonPayClientException

The cancelCharge operation is used to cancel Charges.

Parameters:

chargeId - Charge ID provided by Checkout v2 service

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 cancelCharge 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

cancelCharge

public AmazonPayResponse cancelCharge(String chargeId,
                                      net.sf.json.JSONObject payload)
                               throws AmazonPayClientException

The cancelCharge operation is used to cancel Charges.

Parameters:

chargeId - Charge ID provided by Checkout v2 service

payload - JSONObject request body

Returns:

The response from the cancelCharge 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

createRefund

public AmazonPayResponse createRefund(net.sf.json.JSONObject payload,
                                      Map<String,String> header)
                               throws AmazonPayClientException

The CreateRefund operation is used to create a refund for a buyer and pass the Id as part of button click.

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 CreateRefunds 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

createRefund

public AmazonPayResponse createRefund(net.sf.json.JSONObject payload)
                               throws AmazonPayClientException

The CreateRefund operation is used to create a refund for a buyer and pass the Id as part of button click.

Parameters:

payload - JSONObject request body

Returns:

The response from the CreateRefunds 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

getRefund

public AmazonPayResponse getRefund(String refundId,
                                   Map<String,String> header)
                            throws AmazonPayClientException

The getRefund operation is used to get refund details that contain

Parameters:

refundId - Refund ID provided by Checkout v2 service

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 getRefund 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

getRefund

public AmazonPayResponse getRefund(String refundId)
                            throws AmazonPayClientException

The getRefund operation is used to get refund details that contain

Parameters:

refundId - Refund ID provided by Checkout v2 service

Returns:

The response from the getRefund 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