 |  |
| | |
The Settle operation charges the buyer's payment instrument for the purchase that was reserved. When you do not select the Do you want to settle immediately? check box (see Configuring Default Button Values
), the buyer is not actually charged by Amazon Simple Pay for their purchase; rather the purchase price is reserved against their payment instrument. To charge the buyer for their purchase, you must settle the charge using the Settle operation. One way you could settle a transaction is to charge the payment instrument when you fulfill the order, for example, when you ship the purchased items.
![[Note]](images/note.png) | Note |
|---|---|
This action is an Amazon Flexible Payment Service (Amazon FPS) action. In order to execute this action, you must have an AWS Developer account. For information about how to get an account, see "Before you Begin" in the Amazon Simple Pay Getting Started Guide. |
| Parameter | Description | Required |
|---|---|---|
|
|
An identifier returned by Type: String Constraint: 35 characters maximum Default: None |
Yes |
|
|
Amount to be settled. This cannot exceed the reserve amount. Type: Amount Default: The amount reserved in the |
No |
You must also use parameters that are common to all requests that are described in Common Request Parameters. Parameter names are case sensitive.
| Element | Description |
|---|---|
|
|
Identifies the transaction that was settled. Always returned. Type: String |
|
|
Provides the status of the transaction. Always returned. Type: TransactionStatus |
Responses also include elements common to all responses. For more information, see Common Response Elements.
This action can return the following errors:
| Note |
|---|---|
In order to provide a secure request, you must generate a signature whenever you make a call using this action. For more information, see Keeping Payments Secure |
https://fps.sandbox.amazonaws.com?ReserveTransactionId=14GKD9GE66FAA63E6O6B2JDPZKN53LZ7F22 Action=Settle &AWSAccessKeyId=AKIAIIFXJCFIHITREP4Q &Signature=SJJLsIBghi7VIycBjX7c3hnfgZ%2FBvZbzqLtAZXDL8ys%3D &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Version=2008-09-17 &Timestamp=2009-10-06T07%3A53%3A11.750Z &TransactionAmount.CurrencyCode=USD &TransactionAmount.Value=1 &Version=2008-09-17
This section shows a sample response to a REST request.
<SettleResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
<SettleResult>
<TransactionId>14GKD9GE66FAA63E6O6B2JDPZKN53LZ7F22</TransactionId>
<TransactionStatus>Pending</TransactionStatus>
</SettleResult>
<ResponseMetadata>
<RequestId>9ed2008b-b230-4ed0-9210-095f77fc2359:0</RequestId>
</ResponseMetadata>
</SettleResponse>This section shows a sample IPN notification to a REST request.
-------------------------- transactionId: 14GKD9GE66FAA63E6O6B2JDPZKN53LZ7F22 statusMessage: The transaction was successful and the payment instrument was charged. transactionDate: 1254815482 signatureVersion: 2 signatureMethod: RSA-SHA1 buyerEmail: new_premium@amazon.com notificationType: TransactionStatus callerReference: CallerReference05 operation: SETTLE transactionStatus: SUCCESS transactionAmount: USD 1.00 recipientEmail: test-caller@amazon.com buyerName: Test Business signature: pwozZP+lYONFq39g13ux44vFFMRAt4eJ9kOUWMV2uPCrvBqzi4LFYDQY5UE3VW8OUiW+qpbukqFz YNvE+8mh7adhX/qee2U8ZUUNZi6LaM3sKtpPxus2ZJ3wDVPjuO02Obtu1G6Eo79iMi8viX7Dz1LL 8pFTdhspHZb0XDWkuOt2pK2aELa7TOZ/pXXUFLvGrn4MOd6INwbyM2fvnJpIDTcNdzedBO3Rw3vp 2f2GfpFAZJD6Imu57rsr9RsHVUqu2bIhJaAgTRFleVKzMHQJqft5jo6M9N4vKmPfccsuAvoF+rDn +/6a9VEvTBrVcvAhJ5jrBp3FkXYkOPbHchqHfQ== recipientName: Test Business paymentMethod: CC certificateUrl: https://fps.sandbox.amazonaws.com/certs/090909/PKICert.pem paymentReason: Reserve statusCode: Success --------------------------
