Refund Line Apply Input

Input representation of the details of a transaction refund request. This representation outlines the properties of a refund, including the refund amount and ID of the payment or credit memo record that the refund is applied to.

JSON Example 

1{
2  "appliedToId": "0aQR00000004ZkKMAU",
3  "amount": 10,
4  "effectiveDate": "2020-08-11T07:53:15.000Z",
5  "comments": "Payment application."
6}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
amountDoubleAmount to refund.Required64.0
appliedToIdStringID of a payment or credit memo record. The refund is applied to this object.Required64.0
commentsStringAdditional details of the refund request.Optional64.0
effectiveDateStringDate from when the refund is in effect.Optional64.0