POST api/me/orders/{orderId}/transaction/{transactionId}/refund?reason={reason}&amount={amount}

This method will refund a specific charge on an order

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	Id of the order record	integer	Required
transactionId	Id of transaction on the order	integer	Required
reason	Refund reason	string	Required
amount	Refund amount	decimal number	Required

Body Parameters

None.

Response Information

Resource Description

Instance of

OrderTransactionModel

Name	Type	Additional information
Id	integer	None.
OrderId	integer	None.
Status	string	None.
Amount	decimal number	None.
IsRefund	boolean	None.
Payee	string	None.
PayeeAddress	string	None.
CcLast4	string	None.
CcBrand	string	None.
RefundReason	string	None.
FailureReason	string	None.
ReceiptNumber	string	None.
CreatedDate	date	None.
ChargeId	string	None.
IsRefundAllowed	boolean	None.
Method	string	None.
Notes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "orderId": 2,
  "status": "sample string 3",
  "amount": 4.0,
  "isRefund": true,
  "payee": "sample string 6",
  "payeeAddress": "sample string 7",
  "ccLast4": "sample string 8",
  "ccBrand": "sample string 9",
  "refundReason": "sample string 10",
  "failureReason": "sample string 11",
  "receiptNumber": "sample string 12",
  "createdDate": "2025-05-20T16:39:27.7469793-05:00",
  "chargeId": "sample string 14",
  "isRefundAllowed": true,
  "method": "sample string 16",
  "notes": "sample string 17"
}

text/html

Sample:

{"id":1,"orderId":2,"status":"sample string 3","amount":4.0,"isRefund":true,"payee":"sample string 6","payeeAddress":"sample string 7","ccLast4":"sample string 8","ccBrand":"sample string 9","refundReason":"sample string 10","failureReason":"sample string 11","receiptNumber":"sample string 12","createdDate":"2025-05-20T16:39:27.7469793-05:00","chargeId":"sample string 14","isRefundAllowed":true,"method":"sample string 16","notes":"sample string 17"}

application/xml, text/xml

Sample:

<OrderTransactionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.OrderProcessing">
  <Amount>4</Amount>
  <CcBrand>sample string 9</CcBrand>
  <CcLast4>sample string 8</CcLast4>
  <ChargeId>sample string 14</ChargeId>
  <CreatedDate>2025-05-20T16:39:27.7469793-05:00</CreatedDate>
  <FailureReason>sample string 11</FailureReason>
  <Id>1</Id>
  <IsRefund>true</IsRefund>
  <IsRefundAllowed>true</IsRefundAllowed>
  <Method>sample string 16</Method>
  <Notes>sample string 17</Notes>
  <OrderId>2</OrderId>
  <Payee>sample string 6</Payee>
  <PayeeAddress>sample string 7</PayeeAddress>
  <ReceiptNumber>sample string 12</ReceiptNumber>
  <RefundReason>sample string 10</RefundReason>
  <Status>sample string 3</Status>
</OrderTransactionModel>