Settle

Description

The Settle action charges the sender's payment instrument for the purchase that was transacted using Reserve. You settle a transaction when you fulfill the order, for example, when you ship the purchased items.

Request Parameters

Parameter Description Required

Parameter	Description	Required
`ReserveTransactionId`	An identifier returned by `Reserve` that identifies the reserved transaction to be settled. Type: String Default: None Constraint: Max size = 35 characters	Yes
`TransactionAmount`	Amount to be settled. To understand how to correctly specify the amount in a REST request, see the example request at the end of this topic. Type: Amount Default: The amount reserved in the `Reserve` request Constraint: The amount cannot exceed the reserved amount.	No

ReserveTransactionId

An identifier returned by Reserve that identifies the reserved transaction to be settled.

Type: String

Default: None

Constraint: Max size = 35 characters

Yes

TransactionAmount

Amount to be settled.

To understand how to correctly specify the amount in a REST request, see the example request at the end of this topic.

Type: Amount

Default: The amount reserved in the Reserve request

Constraint: The amount cannot exceed the reserved amount.

No

For REST requests, you must also include parameters that are common to all requests. These parameters are included by default in SOAP requests. For more information, see Common Request Parameters.

Response Elements

Element Description

Element	Description
`TransactionId`	Identifies the transaction that was settled. Type: String Size: 35 Bytes
`TransactionStatus`	Provides the status of the transaction. Type: TransactionStatus

TransactionId

Identifies the transaction that was settled.

Type: String

Size: 35 Bytes

TransactionStatus

Provides the status of the transaction.

Type: TransactionStatus

Responses also include elements common to all responses. For more information, see Common Response Elements.

Errors

This action can return the following errors:

Examples

Sample REST Request

https://fps.sandbox.amazonaws.com?
Action=Settle
&AWSAccessKeyId=AKIAIIFXJCFIHITREP4Q
&ReserveTransactionId=14GKD9GE66FAA63E6O6B2JDPZKN53LZ7F22
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Signature=SJJLsIBghi7VIycBjX7c3hnfgZ%2FBvZbzqLtAZXDL8ys%3D
&Timestamp=2009-10-06T07%3A53%3A11.750Z
&TransactionAmount.CurrencyCode=USD
&TransactionAmount.Value=1
&Version=2008-09-17

Sample SOAP Request

https://fps.amazonaws.com/?
Action=Settle
&AWSAccessKeyId=0656Example83G2
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2008-08-06T13%3A00%3A01Z
&TransactionId=254656Example83987
&Version=2008-09-17
&Signature=<URL-encoded signature value>

Sample Response to 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>

Sample Response to SOAP Request

<SettleResponse
  xmlns="https://fps.amazonaws.com/doc/2008-09-17/">
  <SettleResult>
    <TransactionId>
      254656Example83987
    </TransactionId>
    <TransactionStatus>
      Pending
    </TransactionStatus>
  </SettleResult>
  <ResponseMetadata>
    <RequestId>
      a8d5e97c-6a7e-4fe1-b019-58a428a5a68b:0
    </RequestId>
  </ResponseMetadata>
</SettleResponse>

Sample IPN Pending Notification to Rest Request

--------------------------
transactionId: 14GKD9GE66FAA63E6O6B2JDPZKN53LZ7F22
statusMessage: The transaction is awaiting a response from the backend payment processor.
transactionDate: 1254815482
signatureVersion: 2
signatureMethod: RSA-SHA1
buyerEmail: new_premium@amazon.com
notificationType: TransactionStatus
callerReference: CallerReference05
transactionAmount: USD 1.00
transactionStatus: PENDING
operation: SETTLE
recipientEmail: test-caller@amazon.com
buyerName: Test Business
signature: zxymWMlhu4o+2rpdrBXu08EACZ3Mi3Z16x5+8+1Hbqkh4DTr1A6ry4fijBYkl32z4fMF9xnoGriW
2jzij7Vmc/4Vc4dEWCpbOq+be4JLfOELw08jJQintuk3kIXOPca06NMWQhGiC3m7kRF95nM2TJs7
jqbkAMrKyiZArcURMo0YpRZPIF7DlDlNRAebH2+0v0BxaUtombrDFW4UlSscuebXDNdgjp7KjCnT
BJGDJks9/wLKKvFtISQWHuvN2MiPzt7UmFwMLPh8jtpgQ6JxS+ipTPxbr7Km3IXIJJgJHpxmdQmg
ghrl4IX0zCKaVUb7Rh3z85/9F0yPB8A92nquzQ==
recipientName: Test Business
paymentMethod: CC
certificateUrl: https://fps.sandbox.amazonaws.com/certs/090909/PKICert.pem
paymentReason: Reserve
statusCode: PendingNetworkResponse
--------------------------

Sample IPN Success Notification to 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
--------------------------