Object Index / Definition

You are viewing an old version of the API
Payment​Refund

Represents a refund of a payment made using Square

Contains information on the original payment and the amount of money refunded.

Properties

Name Description
id
string

Required

Unique ID for this refund, generated by Square.

Max Length 192 Min Length 1
amount_money
Money

Required

The amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents.

app_fee_money
Money

Amount 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.

created_at
string

Timestamp of when the refund was created, in RFC 3339 format.

location_id
string

Location ID associated with the payment this refund is attached to.

order_id
string

The ID of the order associated with the refund.

payment_id
string

The ID of the payment assocated with this refund.

processing_fee
Processing​Fee [ ]

Processing fees and fee adjustments assessed by Square on this refund.

reason
string

The reason for the refund.

status
string

The refund's status:

  • PENDING - awaiting approval
  • COMPLETED - successfully completed
  • REJECTED - the refund was rejected
  • FAILED - an error occurred
updated_at
string

Timestamp of when the refund was last updated, in RFC 3339 format.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?