Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.75 KB

payment-refund.md

File metadata and controls

51 lines (42 loc) · 3.75 KB
Raw

Payment Refund

Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded.

Structure

PaymentRefund

Fields

Name Type Tags Description
id string Required The unique ID for this refund, generated by Square.
Constraints: Minimum Length: 1, Maximum Length: 255
status string | undefined Optional The refund's status:

- PENDING - Awaiting approval.
- COMPLETED - Successfully completed.
- REJECTED - The refund was rejected.
- FAILED - An error occurred.
Constraints: Maximum Length: 50
locationId string | undefined Optional The location ID associated with the payment this refund is attached to.
Constraints: Maximum Length: 50
unlinked boolean | undefined Optional Flag indicating whether or not the refund is linked to an existing payment in Square.
destinationType string | undefined Optional The destination type for this refund.

Current values include CARD, BANK_ACCOUNT, WALLET, CASH, or EXTERNAL.
Constraints: Maximum Length: 50
destinationDetails DestinationDetails | undefined Optional Details about a refund's destination.
amountMoney Money Required Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
appFeeMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
processingFee ProcessingFee[] | undefined Optional Processing fees and fee adjustments assessed by Square for this refund.
paymentId string | undefined Optional The ID of the payment associated with this refund.
Constraints: Maximum Length: 192
orderId string | undefined Optional The ID of the order associated with the refund.
Constraints: Maximum Length: 192
reason string | undefined Optional The reason for the refund.
Constraints: Maximum Length: 192
createdAt string | undefined Optional The timestamp of when the refund was created, in RFC 3339 format.
Constraints: Maximum Length: 32
updatedAt string | undefined Optional The timestamp of when the refund was last updated, in RFC 3339 format.
Constraints: Maximum Length: 32
teamMemberId string | undefined Optional An optional ID of the team member associated with taking the payment.
Constraints: Maximum Length: 192

Example (as JSON)

{
  "id": "id0",
  "status": null,
  "location_id": null,
  "destination_type": null,
  "destination_details": null,
  "amount_money": {
    "amount": null,
    "currency": null
  },
  "app_fee_money": null,
  "processing_fee": null,
  "payment_id": null,
  "order_id": null,
  "reason": null
}