Report Payment Status
The Fraud and Abuse feedback api provides customers the ability to report shopper payment status
prevent repeat entry for shoppers with outstanding balance
Note: In the future, new attributes might be added. We recommend that you structure your code so that it can handle new
attributes gracefully
Operations
ReportPaymentStatus
POST v1/feedback/payment-status
Body parameter
{
"storeId": "string",
"shoppingTripId": "string",
"totalAmount": {
"amount": 0,
"code": "str"
},
"settledAmount": {
"amount": 0,
"code": "str"
},
"paymentStatusTime": 0
}
| Data Field |
Required |
Description |
| storeId |
Required |
string <= 255 characters ^[0-9a-zA-Z_-]*$. The storeId field contains the store identifier designated during your onboarding process. If you have multiple stores, each store will have a unique identifier. You use this field to identify in which one of your store locations a shopper is requesting access |
| shoppingTripId |
Required |
string <= 255 characters ^[0-9a-zA-Z_-]+$. The ShoppingTripId field contains a Universally Unique ID (UUID) for the current shopping trip. Amazon generates a UUID for each shopping trip. |
| totalAmount |
Required |
number, The amount field contains the calculated price for the cart. |
| Data Field |
Required |
Description |
| amount |
Required |
number. The amount field contains the calculated price for the cart that will be charged to the shopper payment mechanism. |
| code |
Required |
string <= 3 characters ^[A-Z]{3}$. CurrencyCode field contains an enumerated string representing the type of currency you are collecting. For example, if you’re collecting U.S. dollars, you would enter USD into this field. |
|
| settledAmount |
Required |
number, The amount field contains the settled amount. |
| Data Field |
Required |
Description |
| amount |
Required |
number. The amount field contains the calculated price for the cart that will be charged to the shopper payment mechanism. |
| code |
Required |
string <= 3 characters ^[A-Z]{3}$. CurrencyCode field contains an enumerated string representing the type of currency you are collecting. For example, if you’re collecting U.S. dollars, you would enter USD into this field. |
|
Success example responses
> 200 Response
{
"status": "Accepted",
"reasonCode": "string"
}
| Data Field |
Description |
| status |
string (FeedbackOutputStatus)Enum: "Accepted" "Rejected". |
| reasonCode |
string |
Failure example responses
| Status |
Meaning |
Description |
| 400 |
UnknownShoppingTrip |
You will receive a 400 UnknownShoppingTrip if you attempt to calling the API using an invalid shoppingTrip |
| 400 |
BadRequestException |
The API returns a 400 Bad Request Error when requests to the API might be missing a required value or an incorrect data type is passed to the API. For example an incorrect storeId or shoppingTripId |
| 500 |
ServiceException |
A 500 ServerError is received when the API call fails due to a server issue. For example an un-handled exception or error occurs when processing the API call. You are encouraged to retry the API call to Amazon using an exponential backoff algorithm |
