• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
PaymentRefund

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 255 Min Length 1
status
string

The refund's status:

  • PENDING - awaiting approval
  • COMPLETED - successfully completed
  • REJECTED - the refund was rejected
  • FAILED - an error occurred
Max Length 50
location_id
string

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

Max Length 50
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.

processing_fee
ProcessingFee [ ]

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

payment_id
string

The ID of the payment assocated with this refund.

Max Length 192
order_id
string

The ID of the order associated with the refund.

Max Length 192
reason
string

The reason for the refund.

Max Length 192
created_at
string

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

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 32
updated_at
string

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

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length 32

Share Feedback

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