<- Object

Object

All versions ->

PaymentRefund

Represents a refund of a payment made using Square.

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

Link to section

Properties

Link to section

id

string

Required

Unique ID for this refund, generated by Square.

Min Length
1
Max Length
255
Link to section

status

string

The refund's status:

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

location_id

string

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

Max Length
50
Link to section

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

Link to section

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

Link to section

processing_fee

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

Link to section

payment_id

string

The ID of the payment assocated with this refund.

Max Length
192
Link to section

order_id

string

The ID of the order associated with the refund.

Max Length
192
Link to section

reason

string

The reason for the refund.

Max Length
192
Link to section

created_at

string

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

Examples for January 25th, 2020 6:25: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
Link to section

updated_at

string

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

Examples for January 25th, 2020 6:25: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