| Package | Description |
|---|---|
| com.amazon.pay.api |
| Modifier and Type | Method and Description |
|---|---|
static PrivateKey |
Util.buildPrivateKey(char[] privateKey)
Builds the PrivateKey object from the private key provided
|
AmazonPayResponse |
AmazonPayClient.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 |
WebstoreClient.cancelCharge(String chargeId,
org.json.JSONObject payload)
The cancelCharge operation is used to cancel Charges.
|
AmazonPayResponse |
WebstoreClient.cancelCharge(String chargeId,
org.json.JSONObject payload,
Map<String,String> header)
The cancelCharge operation is used to cancel Charges.
|
AmazonPayResponse |
WebstoreClient.cancelReportSchedule(String reportScheduleId) |
AmazonPayResponse |
WebstoreClient.cancelReportSchedule(String reportScheduleId,
Map<String,String> header)
The cancelReportSchedule operation is used to cancel the report schedule with the given reportScheduleId.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
InstoreClient.charge(org.json.JSONObject chargeRequest)
Helps the merchant make the charge request
|
AmazonPayResponse |
InstoreClient.charge(org.json.JSONObject chargeRequest,
Map<String,String> header)
Helps the solution provider make the charge request with their auth token
|
AmazonPayResponse |
WebstoreClient.closeChargePermission(String chargePermissionId,
org.json.JSONObject payload)
The CloseChargePermission operation Moves the Charge Permission to a Closed state.
|
AmazonPayResponse |
WebstoreClient.closeChargePermission(String chargePermissionId,
org.json.JSONObject payload,
Map<String,String> header)
The CloseChargePermission operation Moves the Charge Permission to a Closed state.
|
AmazonPayResponse |
WebstoreClient.completeCheckoutSession(String checkoutSessionId,
org.json.JSONObject payload)
The CompleteCheckoutSession operation is used to confirm completion of a checkout session.
|
AmazonPayResponse |
WebstoreClient.completeCheckoutSession(String checkoutSessionId,
org.json.JSONObject payload,
Map<String,String> header)
The CompleteCheckoutSession operation is used to confirm completion of a checkout session
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.convertQueryParamters(Map<String,List<String>> parameters) |
String |
SignatureHelper.createCanonicalRequest(URI uri,
String httpMethodName,
Map<String,List<String>> parameters,
String requestPayload,
Map<String,List<String>> preSignedHeaders)
Creates a string that includes the information from the request in a standardized(canonical) format.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.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 |
AccountManagementClient.createMerchantAccount(org.json.JSONObject payload,
Map<String,String> header)
Creates a new merchant account in Amazon Pay.
|
Map<String,List<String>> |
SignatureHelper.createPreSignedHeaders(URI uri,
Map<String,String> header)
Creates the mandatory headers required in the request
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.createReportSchedule(org.json.JSONObject payload,
Map<String,String> header)
The createReport operation is used to create a report schedule for the given reportType.
|
AmazonPayResponse |
AmazonPayClient.deleteAmazonPayAccount(String merchantAccountId) |
AmazonPayResponse |
AmazonPayClient.deleteAmazonPayAccount(String merchantAccountId,
Map<String,String> header)
Deletes the Merchant account for the given Merchant Account ID.
|
AmazonPayResponse |
AmazonPayClient.deliveryTracker(org.json.JSONObject payload)
The Delivery Tracker operation is used to track the delivery status
|
AmazonPayResponse |
AmazonPayClient.deliveryTracker(org.json.JSONObject payload,
Map<String,String> header)
The Delivery Tracker operation is used to track the delivery status
|
static AmazonPayResponse |
Util.enhanceResponseWithShippingAddressList(AmazonPayResponse amazonPayResponse)
Enhances checkoutSession response by parsing shippingAddressList to JSONObject
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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
|
String |
AmazonPayClient.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 |
AmazonPayClient.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 |
AmazonPayClient.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.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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.
|
String |
SignatureHelper.getCanonicalizedQueryString(Map<String,List<String>> parameters)
Generates a canonical string that consists of all the query parameters
|
AmazonPayResponse |
WebstoreClient.getCharge(String chargeId)
The getCharge operation is used to get charges details that contain
|
AmazonPayResponse |
WebstoreClient.getCharge(String chargeId,
Map<String,String> header)
The getCharge operation is used to get charges details that contain
|
AmazonPayResponse |
WebstoreClient.getChargePermission(String chargePermissionId)
The GetChargePermission operation is used to get the complete details of ChargePermission.
|
AmazonPayResponse |
WebstoreClient.getChargePermission(String chargePermissionId,
Map<String,String> header)
The GetChargePermission operation is used to get the complete details of ChargePermission.
|
AmazonPayResponse |
WebstoreClient.getCheckoutSession(String checkoutSessionId)
The GetCheckoutSession operation is used to get checkout session details that contain
all session associated details.
|
AmazonPayResponse |
WebstoreClient.getCheckoutSession(String checkoutSessionId,
Map<String,String> header)
The GetCheckoutSession operation is used to get checkout session details that contain
all session associated details.
|
AmazonPayResponse |
WebstoreClient.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.
|
static org.apache.http.client.methods.HttpUriRequest |
Util.getHttpUriRequest(URI uri,
String httpMethodName,
String payload)
Returns the HttpUriRequest object based on the given HTTP Method Name and URI specification.
|
AmazonPayResponse |
WebstoreClient.getRefund(String refundId)
The getRefund operation is used to get refund details that contain
|
AmazonPayResponse |
WebstoreClient.getRefund(String refundId,
Map<String,String> header)
The getRefund operation is used to get refund details that contain
|
AmazonPayResponse |
WebstoreClient.getReportById(String reportId) |
AmazonPayResponse |
WebstoreClient.getReportById(String reportId,
Map<String,String> header)
The getReportById operation is used to get report details for the given reportId.
|
AmazonPayResponse |
WebstoreClient.getReportDocument(String reportDocumentId) |
AmazonPayResponse |
WebstoreClient.getReportDocument(String reportDocumentId,
Map<String,String> header)
The getReportDocument operation is used to return the pre-signed S3 URL for the report.
|
AmazonPayResponse |
WebstoreClient.getReports() |
AmazonPayResponse |
WebstoreClient.getReports(Map<String,List<String>> queryParameters) |
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.getReportScheduleById(String reportScheduleId) |
AmazonPayResponse |
WebstoreClient.getReportScheduleById(String reportScheduleId,
Map<String,String> header)
The getReportScheduleById operation is used to get report schedule details that match the given ID.
|
AmazonPayResponse |
WebstoreClient.getReportSchedules() |
AmazonPayResponse |
WebstoreClient.getReportSchedules(String reportTypes) |
AmazonPayResponse |
WebstoreClient.getReportSchedules(String reportTypes,
Map<String,String> header)
The getReportSchedules operation is used to return the pre-signed S3 URL for the report.
|
static URI |
Util.getServiceURI(PayConfiguration payConfiguration,
String action)
To get the service URI
|
AmazonPayResponse |
AccountManagementClient.merchantAccountClaim(String merchantAccountId,
org.json.JSONObject payload,
Map<String,String> header)
Claims an existing merchant account using the provided Merchant Account ID.
|
AmazonPayResponse |
InstoreClient.merchantScan(org.json.JSONObject scanRequest)
Helps the merchant make the merchantScan request
|
AmazonPayResponse |
InstoreClient.merchantScan(org.json.JSONObject scanRequest,
Map<String,String> header)
Helps the solution provider make the merchantScan request with their auth token
|
AmazonPayResponse |
InstoreClient.refund(org.json.JSONObject refundRequest)
Helps the merchant make the refund request
|
AmazonPayResponse |
InstoreClient.refund(org.json.JSONObject refundRequest,
Map<String,String> header)
Helps the solution provider make the refund request with their auth token
|
AmazonPayResponse |
AmazonPayClient.registerAmazonPayAccount(org.json.JSONObject payload) |
AmazonPayResponse |
AmazonPayClient.registerAmazonPayAccount(org.json.JSONObject payload,
Map<String,String> header)
Creates a non-logginable account for your merchant partners.
|
PayConfiguration |
PayConfiguration.setPrivateKey(char[] privateKey) |
PayConfiguration |
PayConfiguration.setPrivateKey(String privateKey)
Deprecated.
This method is deprecated, instead use setPrivateKey(char[] privateKey)
|
Map<String,String> |
RequestSigner.signRequest(URI uri,
String httpMethodName,
Map<String,List<String>> queryParameters,
String requestPayload,
Map<String,String> header)
Signs the request provided and returns the signed headers map
|
AmazonPayResponse |
AmazonPayClient.updateAmazonPayAccount(String merchantAccountId,
org.json.JSONObject payload) |
AmazonPayResponse |
AmazonPayClient.updateAmazonPayAccount(String merchantAccountId,
org.json.JSONObject payload,
Map<String,String> header)
Updates a merchant account for the given Merchant Account ID.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
WebstoreClient.updateChargePermission(String chargePermissionId,
org.json.JSONObject payload)
The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
|
AmazonPayResponse |
WebstoreClient.updateChargePermission(String chargePermissionId,
org.json.JSONObject payload,
Map<String,String> header)
The UpdateChargePermission operation is used to update the metadata of the ChargePermission.
|
AmazonPayResponse |
WebstoreClient.updateCheckoutSession(String checkoutSessionId,
org.json.JSONObject payload)
The UpdateCheckoutSession operation is used to update payment details for a session.
|
AmazonPayResponse |
WebstoreClient.updateCheckoutSession(String checkoutSessionId,
org.json.JSONObject payload,
Map<String,String> header)
The UpdateCheckoutSession operation is used to update payment details for a session.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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 |
AccountManagementClient.updateMerchantAccount(String merchantAccountId,
org.json.JSONObject payload,
Map<String,String> header)
Updates a merchant account for the given Merchant Account ID.
|
AmazonPayResponse |
WebstoreClient.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 |
WebstoreClient.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.
|
static String |
Util.urlEncode(String value,
boolean path)
Generates a url encoded string from the given string
|
| Constructor and Description |
|---|
AccountManagementClient(PayConfiguration payConfiguration) |
AmazonPayClient(PayConfiguration payConfiguration) |
InstoreClient(PayConfiguration payConfiguration) |
RequestSigner(PayConfiguration payConfiguration) |
WebstoreClient(PayConfiguration payConfiguration) |
Copyright © 2025. All rights reserved.