Dart
Dart
Amazon Pay - Update Checkout Session
See more Amazon Pay Examples
Update the Checkout Session with transaction details.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId" \
// -X PATCH
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "webCheckoutDetails": {
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
// },
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization":false,
// "softDescriptor": "Descriptor",
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// }
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// }
// }'
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "webCheckoutDetails": {
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
// },
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization": false,
// "softDescriptor": "Descriptor",
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// }
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// }
// }
final json = CkJsonObject();
json.updateString('webCheckoutDetails.checkoutResultReturnUrl', 'https://a.com/merchant-confirm-page');
json.updateString('paymentDetails.paymentIntent', 'AuthorizeWithCapture');
json.updateBool('paymentDetails.canHandlePendingAuthorization', false);
json.updateString('paymentDetails.softDescriptor', 'Descriptor');
json.updateString('paymentDetails.chargeAmount.amount', '1');
json.updateString('paymentDetails.chargeAmount.currencyCode', 'USD');
json.updateString('merchantMetadata.merchantReferenceId', 'Merchant reference ID');
json.updateString('merchantMetadata.merchantStoreName', 'Merchant store name');
json.updateString('merchantMetadata.noteToBuyer', 'Note to buyer');
json.updateString('merchantMetadata.customInformation', 'Custom information');
final sbRequestBody = CkStringBuilder();
json.emitSb(sbRequestBody);
// Load your Amazon Pay private key.
// There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
// or from in-memory strings or bytes.
final privKey = CkPrivateKey();
try {
privKey.loadPemFile('C:/someDir/myAmazonPayPrivateKey.pem');
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Provide your Amazon Pay private key and Public Key ID
// Use your public key ID here. It must be the one associated with the private key.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
final publicKeyId = 'SANDBOX-AHEGSJCM3L2S637RBGABLAFW';
try {
http.setAuthPrivateKey(publicKeyId, privKey);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
// and will also sign the request. Nothing more is needed.
// Chilkat automatically generates and adds the following headers:
//
// x-amz-pay-date
// x-amz-pay-host
// x-amz-pay-region
// Authorization
http.accept = 'application/json';
http.setUrlVar('sessionId', '62b7d028-6c7c-4a43-b077-3897dff27c5b');
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
final resp = CkHttpResponse();
try {
http.httpSb('PATCH', 'https://pay-api.amazon.eu/sandbox/v2/checkoutSessions/{\$sessionId}', sbRequestBody, 'utf-8', 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
final sbResponseBody = CkStringBuilder();
resp.getBodySb(sbResponseBody);
final jResp = CkJsonObject();
jResp.loadSb(sbResponseBody);
jResp.emitCompact = false;
// If the status code is not equal to 200, this will display error information.
print('Response Body:');
print(jResp.emit());
final respStatusCode = resp.statusCode;
print('Response Status Code = $respStatusCode');
if (respStatusCode != 200) {
// A sample response body for the case where the session ID does not exist:
// {
// "reasonCode": "ResourceNotFound",
// "message": "Resource you are trying to access is not available. Requested path '/sandbox/v2/checkoutSessions/bd504926-f659-4ad7-a1a9-9a747aaf5275'"
// }
print('Failed.');
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
// "webCheckoutDetails": {
// "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
// "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
// "checkoutCancelUrl": null,
// "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
// },
// "productType": "PayAndShip",
// "paymentDetails": {
// "paymentIntent": "AuthorizeWithCapture",
// "canHandlePendingAuthorization": false,
// "chargeAmount": {
// "amount": "1",
// "currencyCode": "USD"
// },
// "totalOrderAmount": null,
// "softDescriptor": "Descriptor",
// "presentmentCurrency": "USD",
// "allowOvercharge": null,
// "extendExpiration": null
// },
// "merchantMetadata": {
// "merchantReferenceId": "Merchant reference ID",
// "merchantStoreName": "Merchant store name",
// "noteToBuyer": "Note to buyer",
// "customInformation": "Custom information"
// },
// "supplementaryData": null,
// "buyer": {
// "buyerId": "buyerId",
// "name": "name-1",
// "email": "name@amazon.com",
// "phoneNumber": "800-000-0000",
// "primeMembershipTypes": null
// },
// "billingAddress": {
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US"
// },
// "paymentPreferences": [
// {
// "paymentDescriptor": "Your selected Amazon payment method"
// }
// ],
// "statusDetails": {
// "state": "Open",
// "reasonCode": null,
// "reasonDescription": null,
// "lastUpdatedTimestamp": "20191015T195703Z"
// },
// "shippingAddress": {
// "name": "Susie Smith",
// "addressLine1": "10 Ditka Ave",
// "addressLine2": "Suite 2500",
// "addressLine3": null,
// "city": "Chicago",
// "county": null,
// "district": null,
// "stateOrRegion": "IL",
// "postalCode": "60602",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "platformId": null,
// "chargePermissionId": null,
// "chargeId": null,
// "constraints": [
// ],
// "creationTimestamp": "20191015T195655Z",
// "expirationTimestamp": "20191016T195655Z",
// "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
// "deliverySpecifications": {
// "specialRestrictions": [
// "RestrictPOBoxes"
// ],
// "addressRestrictions": {
// "type": "Allowed",
// "restrictions": {
// "US": {
// "statesOrRegions": [
// "WA"
// ],
// "zipCodes": [
// "95050",
// "93405"
// ]
// },
// "GB": {
// "zipCodes": [
// "72046",
// "72047"
// ]
// },
// "IN": {
// "statesOrRegions": [
// "AP"
// ]
// },
// "JP": {}
// }
// }
// },
// "providerMetadata": {
// "providerReferenceId": null
// },
// "releaseEnvironment": "Sandbox"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
var paymentDescriptor = '';
var strVal = '';
final checkoutSessionId = jResp.stringOf('checkoutSessionId');
final webCheckoutDetailsCheckoutReviewReturnUrl = jResp.stringOf('webCheckoutDetails.checkoutReviewReturnUrl');
final webCheckoutDetailsCheckoutResultReturnUrl = jResp.stringOf('webCheckoutDetails.checkoutResultReturnUrl');
final webCheckoutDetailsCheckoutCancelUrl = jResp.stringOf('webCheckoutDetails.checkoutCancelUrl');
final webCheckoutDetailsAmazonPayRedirectUrl = jResp.stringOf('webCheckoutDetails.amazonPayRedirectUrl');
final productType = jResp.stringOf('productType');
final paymentDetailsPaymentIntent = jResp.stringOf('paymentDetails.paymentIntent');
final paymentDetailsChargeAmountAmount = jResp.stringOf('paymentDetails.chargeAmount.amount');
final paymentDetailsChargeAmountCurrencyCode = jResp.stringOf('paymentDetails.chargeAmount.currencyCode');
final paymentDetailsTotalOrderAmount = jResp.stringOf('paymentDetails.totalOrderAmount');
final paymentDetailsSoftDescriptor = jResp.stringOf('paymentDetails.softDescriptor');
final paymentDetailsPresentmentCurrency = jResp.stringOf('paymentDetails.presentmentCurrency');
final paymentDetailsAllowOvercharge = jResp.stringOf('paymentDetails.allowOvercharge');
final paymentDetailsExtendExpiration = jResp.stringOf('paymentDetails.extendExpiration');
final merchantMetadataMerchantReferenceId = jResp.stringOf('merchantMetadata.merchantReferenceId');
final merchantMetadataMerchantStoreName = jResp.stringOf('merchantMetadata.merchantStoreName');
final merchantMetadataNoteToBuyer = jResp.stringOf('merchantMetadata.noteToBuyer');
final merchantMetadataCustomInformation = jResp.stringOf('merchantMetadata.customInformation');
final supplementaryData = jResp.stringOf('supplementaryData');
final buyerBuyerId = jResp.stringOf('buyer.buyerId');
final buyerName = jResp.stringOf('buyer.name');
final buyerEmail = jResp.stringOf('buyer.email');
final buyerPhoneNumber = jResp.stringOf('buyer.phoneNumber');
final buyerPrimeMembershipTypes = jResp.stringOf('buyer.primeMembershipTypes');
final billingAddressName = jResp.stringOf('billingAddress.name');
final billingAddressAddressLine1 = jResp.stringOf('billingAddress.addressLine1');
final billingAddressAddressLine2 = jResp.stringOf('billingAddress.addressLine2');
final billingAddressAddressLine3 = jResp.stringOf('billingAddress.addressLine3');
final billingAddressCity = jResp.stringOf('billingAddress.city');
final billingAddressCounty = jResp.stringOf('billingAddress.county');
final billingAddressDistrict = jResp.stringOf('billingAddress.district');
final billingAddressStateOrRegion = jResp.stringOf('billingAddress.stateOrRegion');
final billingAddressPostalCode = jResp.stringOf('billingAddress.postalCode');
final billingAddressCountryCode = jResp.stringOf('billingAddress.countryCode');
final statusDetailsState = jResp.stringOf('statusDetails.state');
final statusDetailsReasonCode = jResp.stringOf('statusDetails.reasonCode');
final statusDetailsReasonDescription = jResp.stringOf('statusDetails.reasonDescription');
final statusDetailsLastUpdatedTimestamp = jResp.stringOf('statusDetails.lastUpdatedTimestamp');
final shippingAddressName = jResp.stringOf('shippingAddress.name');
final shippingAddressAddressLine1 = jResp.stringOf('shippingAddress.addressLine1');
final shippingAddressAddressLine2 = jResp.stringOf('shippingAddress.addressLine2');
final shippingAddressAddressLine3 = jResp.stringOf('shippingAddress.addressLine3');
final shippingAddressCity = jResp.stringOf('shippingAddress.city');
final shippingAddressCounty = jResp.stringOf('shippingAddress.county');
final shippingAddressDistrict = jResp.stringOf('shippingAddress.district');
final shippingAddressStateOrRegion = jResp.stringOf('shippingAddress.stateOrRegion');
final shippingAddressPostalCode = jResp.stringOf('shippingAddress.postalCode');
final shippingAddressCountryCode = jResp.stringOf('shippingAddress.countryCode');
final shippingAddressPhoneNumber = jResp.stringOf('shippingAddress.phoneNumber');
final platformId = jResp.stringOf('platformId');
final chargePermissionId = jResp.stringOf('chargePermissionId');
final chargeId = jResp.stringOf('chargeId');
final creationTimestamp = jResp.stringOf('creationTimestamp');
final expirationTimestamp = jResp.stringOf('expirationTimestamp');
final storeId = jResp.stringOf('storeId');
final deliverySpecificationsAddressRestrictionsType = jResp.stringOf('deliverySpecifications.addressRestrictions.type');
final providerMetadataProviderReferenceId = jResp.stringOf('providerMetadata.providerReferenceId');
final releaseEnvironment = jResp.stringOf('releaseEnvironment');
var i = 0;
var countI = jResp.sizeOfArray('paymentPreferences');
while (i < countI) {
jResp.i = i;
paymentDescriptor = jResp.stringOf('paymentPreferences[i].paymentDescriptor');
i++;
}
i = 0;
countI = jResp.sizeOfArray('constraints');
while (i < countI) {
jResp.i = i;
i++;
}
i = 0;
countI = jResp.sizeOfArray('deliverySpecifications.specialRestrictions');
while (i < countI) {
jResp.i = i;
strVal = jResp.stringOf('deliverySpecifications.specialRestrictions[i]');
i++;
}
i = 0;
countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions');
while (i < countI) {
jResp.i = i;
strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.US.statesOrRegions[i]');
i++;
}
i = 0;
countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes');
while (i < countI) {
jResp.i = i;
strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.US.zipCodes[i]');
i++;
}
i = 0;
countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes');
while (i < countI) {
jResp.i = i;
strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.GB.zipCodes[i]');
i++;
}
i = 0;
countI = jResp.sizeOfArray('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions');
while (i < countI) {
jResp.i = i;
strVal = jResp.stringOf('deliverySpecifications.addressRestrictions.restrictions.IN.statesOrRegions[i]');
i++;
}
}