Skip to content

Latest commit

 

History

History
71 lines (62 loc) · 3.39 KB

payment-refund.md

File metadata and controls

71 lines (62 loc) · 3.39 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

Payment Refund

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 Optional The refund's status:

- PENDING - Awaiting approval.
- COMPLETED - Successfully completed.
- REJECTED - The refund was rejected.
- FAILED - An error occurred.
Constraints: Maximum Length: 50
location_id string Optional The location ID associated with the payment this refund is attached to.
Constraints: Maximum Length: 50
amount_money 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.
app_fee_money Money 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.
processing_fee List of Processing Fee Optional Processing fees and fee adjustments assessed by Square for this refund.
payment_id string Optional The ID of the payment associated with this refund.
Constraints: Maximum Length: 192
order_id string Optional The ID of the order associated with the refund.
Constraints: Maximum Length: 192
reason string Optional The reason for the refund.
Constraints: Maximum Length: 192
created_at string Optional The timestamp of when the refund was created, in RFC 3339 format.
Constraints: Maximum Length: 32
updated_at string Optional The timestamp of when the refund was last updated, in RFC 3339 format.
Constraints: Maximum Length: 32

Example (as JSON)

{
  "id": "id0",
  "status": "status8",
  "location_id": "location_id4",
  "amount_money": {
    "amount": 186,
    "currency": "NGN"
  },
  "app_fee_money": {
    "amount": 106,
    "currency": "GBP"
  },
  "processing_fee": [
    {
      "effective_at": "effective_at6",
      "type": "type8",
      "amount_money": {
        "amount": 214,
        "currency": "BWP"
      }
    },
    {
      "effective_at": "effective_at7",
      "type": "type7",
      "amount_money": {
        "amount": 215,
        "currency": "BYR"
      }
    },
    {
      "effective_at": "effective_at8",
      "type": "type6",
      "amount_money": {
        "amount": 216,
        "currency": "BZD"
      }
    }
  ],
  "payment_id": "payment_id0"
}