<- Object

Object

PaymentRefund

Represents a refund of a payment made using Square.

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

Link to section

Properties

Link to section

id

string

Required

The unique ID for this refund, generated by Square.

Link to section

status

string

The refund's status:

  • PENDING - Awaiting approval.
  • COMPLETED - Successfully completed.
  • REJECTED - The refund was rejected.
  • FAILED - An error occurred.
Link to section

location_id

string

The location ID associated with the payment this refund is attached to.

Link to section

unlinked

boolean

Read only Flag indicating whether or not the refund is linked to an existing payment in Square.

Link to section

destination_type

string

The destination type for this refund.

Current values include CARD, BANK_ACCOUNT, WALLET, BUY_NOW_PAY_LATER, CASH, EXTERNAL, and SQUARE_ACCOUNT.

Link to section

destination_details

Read only Contains information about the refund destination. This field is populated only if destination_id is defined in the RefundPayment request.

Link to section

amount_money

Required

The amount of money refunded. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents).

Link to section

app_fee_money

The amount of money the application developer contributed to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts.

Link to section

processing_fee

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

Link to section

payment_id

string

The ID of the payment associated with this refund.

Link to section

order_id

string

The ID of the order associated with the refund.

Link to section

reason

string

The reason for the refund.

Link to section

created_at

string

Read only The 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

Link to section

updated_at

string

Read only The 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

Link to section

team_member_id

string

Read only An optional ID of the team member associated with taking the payment.