Skip to content

Latest commit

 

History

History
75 lines (66 loc) · 3.67 KB

refund.md

File metadata and controls

75 lines (66 loc) · 3.67 KB

Refund

Represents a refund processed for a Square transaction.

Structure

Refund

Fields

Name Type Tags Description Getter
Id String Required The refund's unique ID.
Constraints: Maximum Length: 255		 String getId()
LocationId String Required The ID of the refund's associated location.
Constraints: Maximum Length: 50		 String getLocationId()
TransactionId String Optional The ID of the transaction that the refunded tender is part of.
Constraints: Maximum Length: 192		 String getTransactionId()
TenderId String Required The ID of the refunded tender.
Constraints: Maximum Length: 192		 String getTenderId()
CreatedAt String Optional The timestamp for when the refund was created, in RFC 3339 format.
Constraints: Maximum Length: 32		 String getCreatedAt()
Reason String Required The reason for the refund being issued.
Constraints: Maximum Length: 192		 String getReason()
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.		 Money getAmountMoney()
Status String Required Indicates a refund's current status. String getStatus()
ProcessingFeeMoney Money 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.		 Money getProcessingFeeMoney()
AdditionalRecipients List<AdditionalRecipient> 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.		 List getAdditionalRecipients()

Example (as JSON)

{
  "id": "id6",
  "location_id": "location_id0",
  "transaction_id": "transaction_id4",
  "tender_id": "tender_id4",
  "created_at": "created_at6",
  "reason": "reason8",
  "amount_money": {
    "amount": 186,
    "currency": "AUD"
  },
  "status": "PENDING",
  "processing_fee_money": {
    "amount": 112,
    "currency": "DJF"
  },
  "additional_recipients": [
    {
      "location_id": "location_id0",
      "description": "description6",
      "amount_money": {
        "amount": 186,
        "currency": "AUD"
      },
      "receivable_id": "receivable_id6"
    },
    {
      "location_id": "location_id0",
      "description": "description6",
      "amount_money": {
        "amount": 186,
        "currency": "AUD"
      },
      "receivable_id": "receivable_id6"
    },
    {
      "location_id": "location_id0",
      "description": "description6",
      "amount_money": {
        "amount": 186,
        "currency": "AUD"
      },
      "receivable_id": "receivable_id6"
    }
  ]
}