WriteOffDebt

Description

The WriteOffDebt action dismisses some or all of the debt accumulated on a specified postpaid credit instrument. You typically use this action when you want to offer your customers a discount. When you use this action, you settle the debt partially and dismiss the rest. You can also use this action for accounting purposes if you cannot retrieve the credit from the customer.

Request Parameters

Parameter	Description	Required
`AdjustmentAmount`	The amount to be written off. You can get the maximum amount that can be written off using `GetDebtBalance` on the credit instrument. To learn how to specify the amount correctly in a REST request, see the example request at the end of this topic. Type: Amount Default: None Valid Values: Less than or equal to the current debt balance	Yes
`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 postpaid credit instrument for which the debt balance will be written off. 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

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=WriteOffDebt&
  AWSAccessKeyId=0656Example83G2&
  SignatureVersion=1&
  Timestamp=2008-08-06T13%3A00%3A01Z&
  CretidInstrumentId=254656Example83987&
  CallerReference=293847SKDJRH29387&
  AdjustmentAmount.CurrencyCode=USD&
  AdjustmentAmount.Value=1200&
  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:WriteOffDebt xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/">
     <ns2:CreditInstrumentId>J79851HA56JBX434EJG9SGMYUZDPJPYZAR5BXCF4G59MGUBUMHX5XJ9EJKCZIXN4</ns2:CreditInstrumentId>
     <ns2:AdjustmentAmount>
       <ns2:CurrencyCode>USD</ns2:CurrencyCode>
       <ns2:Value>50</ns2:Value>
     </ns2:AdjustmentAmount>
     <ns2:CallerReference>ReferenceString????c5ie12290575241881</ns2:CallerReference>
     <ns2:CallerDescription>DescriptionString-????75gZ12290575241881</ns2:CallerDescription>
   </ns2:WriteOffDebt>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<WriteOffDebtResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
  <WriteOffDebtResult>
    <TransactionId>13OKOJZJ25NM479TDVU4LREENBT72A3PIUR</TransactionId>
    <TransactionStatus>Success</TransactionStatus>
  </WriteOffDebtResult>
  <ResponseMetadata>
    <RequestId>1370e898-8d81-45f0-9b74-20a9682ba531:0</RequestId>
  </ResponseMetadata>
</WriteOffDebtResponse>

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">WriteOffDebt:Response</wsa:Action>
   <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:1370e898-8d81-45f0-9b74-20a9682ba531</wsa:MessageID>
 </SOAP-ENV:Header>
 <SOAP-ENV:Body>
   <WriteOffDebtResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
     <WriteOffDebtResult>
       <TransactionId>13OKOJZJ25NM479TDVU4LREENBT72A3PIUR</TransactionId>
       <TransactionStatus>Success</TransactionStatus>
     </WriteOffDebtResult>
     <ResponseMetadata>
       <RequestId>1370e898-8d81-45f0-9b74-20a9682ba531:0</RequestId>
     </ResponseMetadata>
   </WriteOffDebtResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>