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

connectionManager, payConfiguration, requestSigner

Constructor Summary

Constructors

Constructor and Description
WebstoreClient(PayConfiguration payConfiguration)

Method Summary

Modifier and Type	Method and Description
AmazonPayResponse	cancelCharge(String chargeId, org.json.JSONObject payload) The cancelCharge operation is used to cancel Charges.
AmazonPayResponse	cancelCharge(String chargeId, org.json.JSONObject payload, Map<String,String> header) The cancelCharge operation is used to cancel Charges.
AmazonPayResponse	cancelReportSchedule(String reportScheduleId)
AmazonPayResponse	cancelReportSchedule(String reportScheduleId, Map<String,String> header) The cancelReportSchedule operation is used to cancel the report schedule with the given reportScheduleId.
AmazonPayResponse	captureCharge(String chargeId, org.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, org.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, org.json.JSONObject payload) The CloseChargePermission operation Moves the Charge Permission to a Closed state.
AmazonPayResponse	closeChargePermission(String chargePermissionId, org.json.JSONObject payload, Map<String,String> header) The CloseChargePermission operation Moves the Charge Permission to a Closed state.
AmazonPayResponse	completeCheckoutSession(String checkoutSessionId, org.json.JSONObject payload) The CompleteCheckoutSession operation is used to confirm completion of a checkout session.
AmazonPayResponse	completeCheckoutSession(String checkoutSessionId, org.json.JSONObject payload, Map<String,String> header) The CompleteCheckoutSession operation is used to confirm completion of a checkout session
AmazonPayResponse	contestDispute(String disputeId, org.json.JSONObject payload) The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute managed by Amazon, requiring the submission of necessary evidence files within the specified Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).
AmazonPayResponse	contestDispute(String disputeId, org.json.JSONObject payload, Map<String,String> header) The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute managed by Amazon, requiring the submission of necessary evidence files within the specified Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).
String	convertQueryParamters(Map<String,List<String>> parameters)
AmazonPayResponse	createCharge(org.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(org.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(org.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(org.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	createDispute(org.json.JSONObject payload, Map<String,String> header) The createDispute operation is used to notify Amazon of a newly created chargeback dispute by a buyer on a transaction processed by the PSP (Payment Service Provider), ensuring the dispute is properly accounted for in the Amazon Pay systems.
AmazonPayResponse	createRefund(org.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(org.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	createReport(org.json.JSONObject payload, Map<String,String> header) The createReport operation is used to submit a request to generate a report based on the reportType and date range specified.
AmazonPayResponse	createReportSchedule(org.json.JSONObject payload, Map<String,String> header) The createReport operation is used to create a report schedule for the given reportType.
AmazonPayResponse	finalizeCheckoutSession(String checkoutSessionId, org.json.JSONObject payload) The finalizeCheckoutSession operation enables Pay to validate payment critical attributes and also update book-keeping attributes present in merchantMetadata.
AmazonPayResponse	finalizeCheckoutSession(String checkoutSessionId, org.json.JSONObject payload, Map<String,String> header) The finalizeCheckoutSession operation enables Pay to validate payment critical attributes and also update book-keeping attributes present in merchantMetadata
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	getDisbursements(Map<String,List<String>> queryParameters, Map<String,String> header) The getDisbursements operation is used to receive disbursement details based on a date range of the settlement date specified in the request.
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	getReportById(String reportId)
AmazonPayResponse	getReportById(String reportId, Map<String,String> header) The getReportById operation is used to get report details for the given reportId.
AmazonPayResponse	getReportDocument(String reportDocumentId)
AmazonPayResponse	getReportDocument(String reportDocumentId, Map<String,String> header) The getReportDocument operation is used to return the pre-signed S3 URL for the report.
AmazonPayResponse	getReports()
AmazonPayResponse	getReports(Map<String,List<String>> queryParameters)
AmazonPayResponse	getReports(Map<String,List<String>> queryParameters, Map<String,String> header) The getReports operation is used to get report details for the reports that match the filters that you specify.
AmazonPayResponse	getReportScheduleById(String reportScheduleId)
AmazonPayResponse	getReportScheduleById(String reportScheduleId, Map<String,String> header) The getReportScheduleById operation is used to get report schedule details that match the given ID.
AmazonPayResponse	getReportSchedules()
AmazonPayResponse	getReportSchedules(String reportTypes)
AmazonPayResponse	getReportSchedules(String reportTypes, Map<String,String> header) The getReportSchedules operation is used to return the pre-signed S3 URL for the report.
AmazonPayResponse	updateCharge(String chargeId, org.json.JSONObject payload) The updateCharge operation is used to update the charge status of any PSP (Payment Service Provider) processed payment method (PPM) transactions.
AmazonPayResponse	updateCharge(String chargeId, org.json.JSONObject payload, Map<String,String> header) The updateCharge operation is used to update the charge status of any PSP (Payment Service Provider) processed payment method (PPM) transactions.
AmazonPayResponse	updateChargePermission(String chargePermissionId, org.json.JSONObject payload) The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
AmazonPayResponse	updateChargePermission(String chargePermissionId, org.json.JSONObject payload, Map<String,String> header) The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
AmazonPayResponse	updateCheckoutSession(String checkoutSessionId, org.json.JSONObject payload) The UpdateCheckoutSession operation is used to update payment details for a session.
AmazonPayResponse	updateCheckoutSession(String checkoutSessionId, org.json.JSONObject payload, Map<String,String> header) The UpdateCheckoutSession operation is used to update payment details for a session.
AmazonPayResponse	updateDispute(String disputeId, org.json.JSONObject payload) The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a buyer for orders processed by a partner PSP (Payment Service Provider), ensuring proper accounting within the Amazon systems.
AmazonPayResponse	updateDispute(String disputeId, org.json.JSONObject payload, Map<String,String> header) The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a buyer for orders processed by a partner PSP (Payment Service Provider), ensuring proper accounting within the Amazon systems.
AmazonPayResponse	uploadFile(org.json.JSONObject payload) The uploadFile operation is utilised by PSPs (Payment Service Provider) to upload file-based evidence when a merchant contests a dispute, providing the necessary reference ID to the evidence file as part of the Update Dispute API process.
AmazonPayResponse	uploadFile(org.json.JSONObject payload, Map<String,String> header) The uploadFile operation is utilised by PSPs (Payment Service Provider) to upload file-based evidence when a merchant contests a dispute, providing the necessary reference ID to the evidence file as part of the Update Dispute API process.

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

callAPI, deleteAmazonPayAccount, deleteAmazonPayAccount, deliveryTracker, deliveryTracker, generateButtonSignature, generateButtonSignature, getAuthorizationToken, getClosableHttpClientWithConnectionPool, getClosableHttpClientWithPoolAndProxy, getPoolStats, registerAmazonPayAccount, registerAmazonPayAccount, updateAmazonPayAccount, updateAmazonPayAccount

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(org.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(org.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,
                                               org.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,
                                               org.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,
                                                 org.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,
                                                 org.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,
                                                org.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,
                                                org.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,
                                               org.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,
                                               org.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(org.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(org.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

updateCharge

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

The updateCharge operation is used to update the charge status of any PSP (Payment Service Provider) processed payment method (PPM) transactions.

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 updateCharge 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.

updateCharge

public AmazonPayResponse updateCharge(String chargeId,
                                      org.json.JSONObject payload)
                               throws AmazonPayClientException

The updateCharge operation is used to update the charge status of any PSP (Payment Service Provider) processed payment method (PPM) transactions.

Parameters:

chargeId - Charge ID provided by Checkout v2 service.

payload - JSONObject request body.

Returns:

The response from the updateCharge 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,
                                       org.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,
                                       org.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,
                                      org.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,
                                      org.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(org.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(org.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

getReports

public AmazonPayResponse getReports(Map<String,List<String>> queryParameters,
                                    Map<String,String> header)
                             throws AmazonPayClientException

The getReports operation is used to get report details for the reports that match the filters that you specify.

Parameters:

queryParameters - Request Paramters as part of filters to be provided optionally while calling API (e.g., reportTypes, processingStatus etc.)

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 the getReports 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

getReports

public AmazonPayResponse getReports(Map<String,List<String>> queryParameters)
                             throws AmazonPayClientException

Throws:

AmazonPayClientException

getReports

public AmazonPayResponse getReports()
                             throws AmazonPayClientException

Throws:

AmazonPayClientException

getReportById

public AmazonPayResponse getReportById(String reportId,
                                       Map<String,String> header)
                                throws AmazonPayClientException

The getReportById operation is used to get report details for the given reportId.

Parameters:

reportId - Report 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 the getReports 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

getReportById

public AmazonPayResponse getReportById(String reportId)
                                throws AmazonPayClientException

Throws:

AmazonPayClientException

getReportDocument

public AmazonPayResponse getReportDocument(String reportDocumentId,
                                           Map<String,String> header)
                                    throws AmazonPayClientException

The getReportDocument operation is used to return the pre-signed S3 URL for the report. The report can be downloaded using this URL.

Parameters:

reportDocumentId - Report Document 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 the getReports 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

getReportDocument

public AmazonPayResponse getReportDocument(String reportDocumentId)
                                    throws AmazonPayClientException

Throws:

AmazonPayClientException

getReportSchedules

public AmazonPayResponse getReportSchedules(String reportTypes,
                                            Map<String,String> header)
                                     throws AmazonPayClientException

The getReportSchedules operation is used to return the pre-signed S3 URL for the report. The report can be downloaded using this URL.

Parameters:

reportTypes - Report Types provided while calling the API comma-seperated list of ReportType

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 the getReports 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

getReportSchedules

public AmazonPayResponse getReportSchedules(String reportTypes)
                                     throws AmazonPayClientException

Throws:

AmazonPayClientException

getReportSchedules

public AmazonPayResponse getReportSchedules()
                                     throws AmazonPayClientException

Throws:

AmazonPayClientException

getReportScheduleById

public AmazonPayResponse getReportScheduleById(String reportScheduleId,
                                               Map<String,String> header)
                                        throws AmazonPayClientException

The getReportScheduleById operation is used to get report schedule details that match the given ID.

Parameters:

reportScheduleId - Report Schedule 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 the getReports 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

getReportScheduleById

public AmazonPayResponse getReportScheduleById(String reportScheduleId)
                                        throws AmazonPayClientException

Throws:

AmazonPayClientException

createReport

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

The createReport operation is used to submit a request to generate a report based on the reportType and date range specified.

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 the getReports 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

createReportSchedule

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

The createReport operation is used to create a report schedule for the given reportType. Only one schedule per report type allowed.

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 the getReports 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

cancelReportSchedule

public AmazonPayResponse cancelReportSchedule(String reportScheduleId,
                                              Map<String,String> header)
                                       throws AmazonPayClientException

The cancelReportSchedule operation is used to cancel the report schedule with the given reportScheduleId.

Parameters:

reportScheduleId - Report Schedule 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 the getReports 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

cancelReportSchedule

public AmazonPayResponse cancelReportSchedule(String reportScheduleId)
                                       throws AmazonPayClientException

Throws:

AmazonPayClientException

getDisbursements

public AmazonPayResponse getDisbursements(Map<String,List<String>> queryParameters,
                                          Map<String,String> header)
                                   throws AmazonPayClientException

The getDisbursements operation is used to receive disbursement details based on a date range of the settlement date specified in the request.

Parameters:

queryParameters - Query Parameters to be provided while calling API (e.g., startTime, endTime, pageSize, etc.)

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

Returns:

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

Throws:

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

finalizeCheckoutSession

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

The finalizeCheckoutSession operation enables Pay to validate payment critical attributes and also update book-keeping attributes present in merchantMetadata

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

finalizeCheckoutSession

public AmazonPayResponse finalizeCheckoutSession(String checkoutSessionId,
                                                 org.json.JSONObject payload)
                                          throws AmazonPayClientException

The finalizeCheckoutSession operation enables Pay to validate payment critical attributes and also update book-keeping attributes present in merchantMetadata.

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

convertQueryParamters

public String convertQueryParamters(Map<String,List<String>> parameters)
                             throws AmazonPayClientException

Throws:

AmazonPayClientException

createDispute

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

The createDispute operation is used to notify Amazon of a newly created chargeback dispute by a buyer on a transaction processed by the PSP (Payment Service Provider), ensuring the dispute is properly accounted for in the Amazon Pay systems.

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, x-amz-pay-date)

Returns:

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

updateDispute

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

The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a buyer for orders processed by a partner PSP (Payment Service Provider), ensuring proper accounting within the Amazon systems.

Parameters:

disputeId - Dispute 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-authtoken, x-amz-pay-date)

Returns:

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

updateDispute

public AmazonPayResponse updateDispute(String disputeId,
                                       org.json.JSONObject payload)
                                throws AmazonPayClientException

The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a buyer for orders processed by a partner PSP (Payment Service Provider), ensuring proper accounting within the Amazon systems.

Parameters:

disputeId - Dispute ID provided while calling the API

payload - JSONObject request body

Returns:

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

contestDispute

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

The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute managed by Amazon, requiring the submission of necessary evidence files within the specified Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).

Parameters:

disputeId - Dispute 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-authtoken, x-amz-pay-date)

Returns:

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

contestDispute

public AmazonPayResponse contestDispute(String disputeId,
                                        org.json.JSONObject payload)
                                 throws AmazonPayClientException

The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute managed by Amazon, requiring the submission of necessary evidence files within the specified Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).

Parameters:

disputeId - Dispute ID provided while calling the API

payload - JSONObject request body

Returns:

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

uploadFile

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

The uploadFile operation is utilised by PSPs (Payment Service Provider) to upload file-based evidence when a merchant contests a dispute, providing the necessary reference ID to the evidence file as part of the Update Dispute API process.

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, x-amz-pay-date)

Returns:

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

uploadFile

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

The uploadFile operation is utilised by PSPs (Payment Service Provider) to upload file-based evidence when a merchant contests a dispute, providing the necessary reference ID to the evidence file as part of the Update Dispute API process.

Parameters:

payload - JSONObject request body

Returns:

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