PaymentRefund

September 24, 2019 ยท View on GitHub

Description

Represents a refund of a payment made using Square. Contains information on the original payment and the amount of money refunded.

Properties

NameTypeDescriptionNotes
idStringUnique ID for this refund, generated by Square.
statusStringThe refund's status: - `PENDING` - awaiting approval - `COMPLETED` - successfully completed - `REJECTED` - the refund was rejected - `FAILED` - an error occurred[optional]
locationIdStringLocation ID associated with the payment this refund is attached to.[optional]
amountMoneyMoneyThe amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.
appFeeMoneyMoneyAmount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See Working with monetary amounts for details.[optional]
processingFeeList<ProcessingFee>Processing fees and fee adjustments assessed by Square on this refund.[optional]
paymentIdStringThe ID of the payment assocated with this refund.[optional]
orderIdStringThe ID of the order associated with the refund.[optional]
reasonStringThe reason for the refund.[optional]
createdAtStringTimestamp of when the refund was created, in RFC 3339 format.[optional]
updatedAtStringTimestamp of when the refund was last updated, in RFC 3339 format.[optional]