Skip to content

Latest commit

 

History

History
14 lines (10 loc) · 1.76 KB

CreateRefundRequest.md

File metadata and controls

14 lines (10 loc) · 1.76 KB

CreateRefundRequest

Properties

Name Getter Setter Type Description Notes
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 Idempotency keys for more information.
tender_id getTenderId() setTenderId($value) string 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 getReason() setReason($value) string A description of the reason for the refund. Default value: `Refund via API` [optional]
amount_money getAmountMoney() setAmountMoney($value) \SquareConnect\Model\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`.

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]