Website logo

Make a refund for a purchase

Performs full or partial refunds against a Ping purchase. Can be called multiple times for partial amounts.

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.
xml Serialize responses into XML.
json Serialize responses into JSON.



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.



Success Boolean

Indicates whether the operation was successful.

Description String or null

The description of the error, if the operation failed.

Example XML Request (switch to JSON)

<RefundRequest xmlns="">

Example JSON Request (switch to XML)

  "PurchaseId": 123,
  "Amount": 123.0

Example XML Response (switch to JSON)

<RefundResponse xmlns="">

Example JSON Response (switch to XML)

  "Success": false,
  "Description": "ABC"