Refund

March 27, 2019 ยท View on GitHub

Description

Represents a refund processed for a Square transaction.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe refund's unique ID.
location_idgetLocationId()setLocationId($value)stringThe ID of the refund's associated location.
transaction_idgetTransactionId()setTransactionId($value)stringThe ID of the transaction that the refunded tender is part of.
tender_idgetTenderId()setTenderId($value)stringThe ID of the refunded tender.
created_atgetCreatedAt()setCreatedAt($value)stringThe time when the refund was created, in RFC 3339 format.[optional]
reasongetReason()setReason($value)stringThe reason for the refund being issued.
amount_moneygetAmountMoney()setAmountMoney($value)\SquareConnect\Model\MoneyThe amount of money refunded to the buyer.
statusgetStatus()setStatus($value)stringThe current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See RefundStatus for possible values
processing_fee_moneygetProcessingFeeMoney()setProcessingFeeMoney($value)\SquareConnect\Model\MoneyThe amount of Square processing fee money refunded to the merchant.[optional]
additional_recipientsgetAdditionalRecipients()setAdditionalRecipients($value)\SquareConnect\Model\AdditionalRecipient[]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.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]