Make a refund for a purchase
Performs full or partial refunds against a Ping purchase. Can be called multiple times for partial amounts.
| URL: | https://api.trademe.co.nz/v1/Ping/Transactions/Refunds.{file_format} | 
|---|---|
| HTTP Method: | POST | 
| Requires Authentication? | Yes | 
| Permission Required: | MyTradeMeWrite: Maintain your watchlist, answer questions and post comments. | 
| Supported Formats: | XML, JSON | 
| Rate Limited? | Yes | 
URL parameters
| file_format | Enumeration (required) | The format of the response. | ||||
|---|---|---|---|---|---|---|
                    
  | 
            ||||||
POST Data
<RefundRequest>
| PurchaseId | Integer (required) | 
                         The ID of the purchase to refund.  | 
                
|---|---|---|
| Amount | Number (required) | 
                         The dollar value to refund. Must be larger than zero and up to the total value of the purchase.  | 
                
Returns
<RefundResponse>
| Success | Boolean | 
                         Indicates whether the operation was successful.  | 
                
|---|---|---|
| Description | String or null | 
                         The description of the error, if the operation failed.  |