create-refund-request.md

Create Refund Request

Defines the body parameters that can be included in a request to the CreateRefund endpoint.

Deprecated - recommend using RefundPayment

Structure

Create Refund Request

Fields

Name	Type	Tags	Description
idempotency_key	string	Required	A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See Idempotency keys for more information. Constraints: Minimum Length: 1, Maximum Length: 192
tender_id	string	Required	The ID of the tender to refund. A Transaction has one or more tenders (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. Constraints: Minimum Length: 1, Maximum Length: 192
reason	string	Optional	A description of the reason for the refund. Default value: Refund via API Constraints: Maximum Length: 192
amount_money	Money	Required	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.

Example (as JSON)

{
  "amount_money": {
    "amount": 100,
    "currency": "USD"
  },
  "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad2",
  "reason": "a reason",
  "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF"
}