refund.md

Refund

Represents a refund processed for a Square transaction.

Structure

Refund

Fields

Name	Type	Tags	Description
id	string	Required	The refund's unique ID. Constraints: Maximum Length: 255
locationId	string	Required	The ID of the refund's associated location. Constraints: Maximum Length: 50
transactionId	string | undefined	Optional	The ID of the transaction that the refunded tender is part of. Constraints: Maximum Length: 192
tenderId	string	Required	The ID of the refunded tender. Constraints: Maximum Length: 192
createdAt	string | undefined	Optional	The timestamp for when the refund was created, in RFC 3339 format. Constraints: Maximum Length: 32
reason	string	Required	The reason for the refund being issued. Constraints: Maximum Length: 192
amountMoney	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.
status	string	Required	Indicates a refund's current status.
processingFeeMoney	Money | undefined	Optional	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.
additionalRecipients	AdditionalRecipient[] | undefined	Optional	Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.

Example (as JSON)

{
  "id": "id0",
  "location_id": "location_id4",
  "transaction_id": null,
  "tender_id": "tender_id8",
  "reason": "reason4",
  "amount_money": {
    "amount": null,
    "currency": null
  },
  "status": "PENDING",
  "processing_fee_money": null,
  "additional_recipients": null
}