refund-payment-response.md

Refund Payment Response

Defines the response returned by RefundPayment.

If there are errors processing the request, the refund field might not be present, or it might be present with a status of FAILED.

Structure

RefundPaymentResponse

Fields

Name	Type	Tags	Description
errors	Error[] | undefined	Optional	Information about errors encountered during the request.
refund	PaymentRefund | undefined	Optional	Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded.

Example (as JSON)

{
  "refund": {
    "amount_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "app_fee_money": {
      "amount": 10,
      "currency": "USD"
    },
    "created_at": "2021-10-13T21:23:19.116Z",
    "id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY_KlWP8IC1557ddwc9QWTKrCVU6m0JXDz15R2Qym5eQfR",
    "location_id": "L88917AVBK2S5",
    "order_id": "1JLEUZeEooAIX8HMqm9kvWd69aQZY",
    "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY",
    "reason": "Example",
    "status": "PENDING",
    "updated_at": "2021-10-13T21:23:19.508Z"
  }
}