PluginProbe
WooCommerce Square / 2.2.5
WooCommerce Square v2.2.5
5.5.0 5.4.3 5.4.2 5.4.1 5.4.0 trunk 1.0.25 1.0.26 1.0.27 1.0.28 1.0.29 1.0.30 1.0.31 1.0.32 1.0.33 1.0.34 1.0.35 1.0.36 1.0.37 1.0.38 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 All 132 releases
woocommerce-square / vendor / square / connect / docs / Model / CreateRefundRequest.md
CreateRefundRequest.md
19 lines 2.0 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 # CreateRefundRequest
2
3 ### Description
4
5 Defines the body parameters that can be included in a request to the [](#endpoint-createrefundCreateRefund](#endpoint-createrefund](#endpoint-createrefund) endpoint. Deprecated - recommend using [](#endpoint-refunds-refundpaymentRefundPayment](#endpoint-refunds-refundpayment](#endpoint-refunds-refundpayment)
6
7 ## Properties
8 Name | Getter | Setter | Type | Description | Notes
9 ------------ | ------------- | ------------- | ------------- | ------------- | -------------
10 **idempotency_key** | getIdempotencyKey() | setIdempotencyKey($value) | **string** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [](/basics/api101/idempotencyIdempotency](/basics/api101/idempotency](/basics/api101/idempotency) for more information. |
11 **tender_id** | getTenderId() | setTenderId($value) | **string** | The ID of the tender to refund. A [](#type-transaction`Transaction`](#type-transaction](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. |
12 **reason** | getReason() | setReason($value) | **string** | A description of the reason for the refund. Default value: `Refund via API` | [optional]
13 **amount_money** | getAmountMoney() | setAmountMoney($value) | [](Money.md**\SquareConnect\Model\Money**](Money.md](Money.md) | The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [](#workingwithmonetaryamountsWorking with monetary amounts](#workingwithmonetaryamounts](#workingwithmonetaryamounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. |
14
15 Note: All properties are protected and only accessed via getters and setters.
16
17 [](../../README.md#documentation-for-models[Back to Model list]](../../README.md#documentation-for-models](../../README.md#documentation-for-models) [](../../README.md#documentation-for-api-endpoints[Back to API list]](../../README.md#documentation-for-api-endpoints](../../README.md#documentation-for-api-endpoints) [](../../README.md[Back to README]](../../README.md](../../README.md)
18
19