squareconnect.models.create_refund_request
Defines the body parameters that can be included in a request to the CreateRefund endpoint.
| Name | Type | Description | Notes |
|---|---|---|---|
| idempotency_key | str | 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 Idempotency for more information. | |
| tender_id | str | The ID of the tender to refund. A `Transaction` has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | |
| reason | str | A description of the reason for the refund. Default value: `Refund via API` | [optional] |
| amount_money | Money | 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 Working with monetary amounts for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. |