SettleDebt

Description

The SettleDebt action settles the accumulated debt on a postpaid credit instrument using a credit card, bank account, or Amazon Payments account balance. The action decrements the debt balance on the postpaid credit instrument by the settlement amount, and moves money from the sender's payment instrument specified in the postpaid payment token to the recipient’s account balance. The transaction fee is deducted from the settlement amount and the remaining amount is deposited into the recipient's account balance. For example, If the debt balance is $100, settlement amount is $90, and the Amazon FPS fee is $2.50, then the SettleDebt action transfers $87.50 into the recipient's account balance and decrements the debt balance by $90. The debt balance is now $10.

The SettleDebt action can't be used for amounts greater than the actual debt balance. For example, if the debt balance is $100, you can't use SettleDebt action for $110.

Settlement tokens can be used multiple times to settle debt (up to its credit limit) and you are charged a fee each time. You specify the credit limit of the token in the Co-Branded service request.

	Note
	The `Refund` action does not support `SettleDebt`.

	Note
	The value you provide for the `SenderTokenId` is the `settlementTokenID` value you received in the Postpaid Token API response, not the value of the `creditSenderTokenID` parameter.

Request Parameters

Parameter	Description	Required
`CallerDescription`	Description of this transaction for the caller. Type: String Default: None Constraint: Max size = 160 characters	No
`CallerReference`	A value you provide that uniquely identifies the request. For more information, see Important Values to Store in Your Database. Type: String Default: None Constraint: Max size = 128 characters	Yes
`CreditInstrumentId`	Specifies the credit instrument to settle. Use the value of the `creditInstrumentID` parameter from the Postpaid Token API response. For more information, see Postpaid Token API. Type: String Default: None	Yes
`DescriptorPolicy`	Specifies the entity whose name and contact details would be displayed in the sender's credit card or bank account statement. Type: DescriptorPolicy Default: None	No
`SenderDescription`	Description of this transaction for the sender. Type: String Default: None Constraint: Max size = 128 bytes	No
`SenderTokenId`	The value of the `settlementTokenID` parameter you received in the Prepaid Token API response. For more information, see Postpaid Token API. Type: String Default: None	Yes
`SettlementAmount`	Specifies the amount of the settlement. Type: Amount Default: None Valid Values: Equal to or less than the debt balance	No
`TransactionTimeoutInMins`	Specifies the number of minutes before the request times out. Use this parameter to specify a timeout value that is acceptable for your business. If Amazon FPS cannot complete the transaction in the time allotted, the transaction is marked as failed and you receive an IPN notification (if you are using IPN). Type: Integer (number of minutes) Default: 10080	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`	Unique ID generated by Amazon FPS for this transaction. This element is returned if the transaction was accepted by Amazon FPS. If the transaction is a Refund request, this parameter will contain the id of the Refund transaction only. Type: String
`TransactionStatus`	Provides the status of the transaction. Type: TransactionStatus

TransactionId

Unique ID generated by Amazon FPS for this transaction. This element is returned if the transaction was accepted by Amazon FPS. If the transaction is a Refund request, this parameter will contain the id of the Refund transaction only.

Type: String

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.amazonaws.com/?
  Action=SettleDebt&
  AWSAccessKeyId=0656Example83G2&
  SignatureVersion=1&
  Timestamp=2008-08-06T13%3A00%3A01Z&
  CallerReference=2987656Example657677&
  CreditInstrumentId=2984656Example93577987&
  SenderTokenId=98796Example865787&
  Version=2008-09-17&
  Signature=<URL-encoded signature value>

Sample SOAP Request

<SOAP-ENV:Body wsu:Id="body" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <ns2:SettleDebt xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/">
     <ns2:SenderTokenId>J4D62EZ3K8IMB3MR18R15RMKNR7VJVMA3I49EFTQ4Q1PN4XE4BBZ5RRQ7NMKSFV6</ns2:SenderTokenId>
     <ns2:CreditInstrumentId>J3D6VEG3KHILB3PR58R65ZMKIRQVJHMB3I996FT84P1PP4QE4BBX5RTQCNMGSUVA</ns2:CreditInstrumentId>
     <ns2:SettlementAmount>
       <ns2:CurrencyCode>USD</ns2:CurrencyCode>
       <ns2:Value>50</ns2:Value>
     </ns2:SettlementAmount>
     <ns2:CallerReference>ReferenceString????gsBq12290565996541</ns2:CallerReference>
     <ns2:CallerDescription>DescriptionString-????d5ik12290565996541</ns2:CallerDescription>
   </ns2:SettleDebt>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<SettleDebtResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
  <SettleDebtResult>
    <TransactionId>13OKNMPO244IU5G38V98NFTP7LPAKPGR73T</TransactionId>
    <TransactionStatus>Pending</TransactionStatus>
  </SettleDebtResult>
  <ResponseMetadata>
    <RequestId>5787db56-61b7-4636-9fd1-7179523ca194:0</RequestId>
  </ResponseMetadata>
</SettleDebtResponse>

Sample Response to SOAP Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP-ENV:Header>
   <wsa:RelatesTo xmlns:wsa="http://www.w3.org/2005/08/addressing">MESSAGE123</wsa:RelatesTo>
   <wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
   <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">SettleDebt:Response</wsa:Action>
   <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:5787db56-61b7-4636-9fd1-7179523ca194</wsa:MessageID>
 </SOAP-ENV:Header>
 <SOAP-ENV:Body>
   <SettleDebtResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
     <SettleDebtResult>
       <TransactionId>13OKNMPO244IU5G38V98NFTP7LPAKPGR73T</TransactionId>
       <TransactionStatus>Pending</TransactionStatus>
     </SettleDebtResult>
     <ResponseMetadata>
       <RequestId>5787db56-61b7-4636-9fd1-7179523ca194:0</RequestId>
     </ResponseMetadata>
   </SettleDebtResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>