Refund Credit Memo

Output representation for the process refund against a credit memo API.

JSON Example 

1{
2  "applications": [
3    {
4      "applicationId": "0CMxx0000000001AAA",
5      "appliedToId": "0PMxx0000000001AAA"
6    }
7  ],
8  "errors": [],
9  "refundId": "0Rfxx0000000001AAA",
10  "success": true
11}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
applicationsRefund Application[]Application records created by the refund. One CreditMemoRefund record for a top-level credit memo, or one CreditMemoLineRefund record per applied line for a line-level credit memo.Big, 68.068.0
errorsRefund Error[]Details of the errors if the API request was unsuccessful.Big, 68.068.0
refund​IdStringID of the created record.Big, 68.068.0
successBooleanIndicates whether the refund was successfully initiated (true) or not (false).Big, 68.068.0
  • Refund Application

    Output representation of a single refund application record created by the refund against a credit memo API.

  • Refund Error

    Output representation of an error that occurred during a refund against a credit memo.