Update info post-checkout
Update Charge Permission to update external merchant metadata such as: buyer note, store name, and external ID after a successful checkout. See the API reference guide for more details.
Request
curl "https://pay-api.amazon.com/:environment/:version/chargePermissions/:chargePermissionId" \
-X PATCH
-H "x-amz-pay-authorization: Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
-d @request_body
Request body
{
"merchantMetadata": {
"merchantReferenceId": "32-41-323141-32",
"merchantStoreName": "AmazonTestStoreFront",
"noteToBuyer": "Some Note to buyer",
"customInformation": ""
}
}
Request parameters
| Name
|
Location
|
Description
|
| chargePermissionId (required) Type: string |
Path Parameter
|
Charge Permission identifier
|
| merchantMetadata Type: merchantMetadata |
Body
|
Merchant-provided order details Modifiable: Once |
Response
{
"chargePermissionId": "chargePermission-1",
"chargePermissionReferenceId": null,
"buyer": {
"buyerId": "buyerId",
"name": "name-1",
"email": "name@amazon.com"
},
"releaseEnvironment": "Live",
"shippingAddress": { // Null for PayOnly product type
"name": "Work",
"addressLine1": "440 Terry Ave",
"addressLine2": "",
"addressLine3": "",
"city": "Seattle",
"county": "King",
"district": "Seattle",
"stateOrRegion": "WA",
"postalCode": "98121",
"countryCode": "US",
"phoneNumber": "800-000-0000"
},
"paymentPreferences": [
{
"billingAddress": { // Only available in EU or for PayOnly product type
"name": "Work",
"addressLine1": "440 Terry Ave",
"addressLine2": "",
"addressLine3": "",
"city": "Seattle",
"county": "King",
"district": "Seattle",
"stateOrRegion": "WA",
"postalCode": "98121",
"countryCode": "US",
"phoneNumber": "800-000-0000"
},
"paymentDescriptor": null
}],
"statusDetail": {
"state": "Chargeable",
"reasons":null,
"lastUpdatedTimestamp": "20190714T155300Z"
},
"creationTimestamp": "20190714T155300Z",
"expirationTimestamp": "20190715T155300Z",
"merchantMetadata": {
"merchantReferenceId": "123-77-876",
"merchantStoreName": "AmazonTestStoreFront",
"noteToBuyer": "merchantNoteForBuyer",
"customInformation": "This is custom information"
},
"platformId": "SPId",
"chargeAmountLimit": {
"amount": "14.00",
"currencyCode": "USD"
},
"presentmentCurrency": "USD"
}