• 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 about the original payment and the amount of money refunded.

Properties
Name Description
id
string
Required

The unique ID for this refund, generated by Square.

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

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

Max Length 50
unlinked
boolean

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

The destination type for this refund.

Current values include CARD, BANK_ACCOUNT, WALLET, CASH, or EXTERNAL.

Max Length 50
destination_details
DestinationDetails

Read only Contains information about the refund destination. This field is populated only if destination_id is defined in the RefundPayment request.
amount_money
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).
app_fee_money
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.
processing_fee
ProcessingFee [ ]

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

The ID of the payment associated 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

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

Max Length 32
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

Max Length 32
team_member_id
string

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

Max Length 192