V1CreateRefundRequest

March 13, 2019 ยท View on GitHub

Description

V1CreateRefundRequest

Properties

NameGetterSetterTypeDescriptionNotes
payment_idgetPaymentId()setPaymentId($value)stringThe ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund.
typegetType()setType($value)stringTThe type of refund (FULL or PARTIAL). See V1CreateRefundRequestType for possible values
reasongetReason()setReason($value)stringThe reason for the refund.
refunded_moneygetRefundedMoney()setRefundedMoney($value)\SquareConnect\Model\V1MoneyThe amount of money to refund. Required only for PARTIAL refunds.[optional]
request_idempotence_keygetRequestIdempotenceKey()setRequestIdempotenceKey($value)stringAn optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.[optional]

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

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