---
schema_version: "1"
id: 7c982e92471c720851b506dfa89f66b4dcacc010db18b256fea3f857dd810fe3
title: Refund Fields
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/commerce/264-0-0/om_refund_fields.md
canonical_url: https://help.salesforce.com/s/articleView?id=commerce.om_refund_fields.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: f4e441014e62010853397beb5e3570cee6a61ff5f3683613e58080737a748f40
description: The Refund object represents a single refund transaction.
products:
  - Commerce
  - Salesforce Order Management
release: "264"
---
# Refund Fields

The Refund object represents a single refund transaction.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;"><a href="https://help.salesforce.com/s/articleView?id=commerce.om_editions.htm&amp;language=en_US" target="_blank">View supported editions</a>.</td></tr></tbody></table>

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-commerce-om_order_management-264-0-0-production-enus/4c4844e3-a194-4a65-95b7-17291a6dbefa/images/icon_note.png)

Note Depending on your page layout and field-level security settings, some fields aren’t visible or editable.

This table lists the fields on the Refund object.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d24363e66">Field</th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d24363e69">Label</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Account</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The customer account containing the payment that this refund targets.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Amount</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">Total amount of this refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Audit Email</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The email address of the customer who initiated the refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Balance</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>Remaining balance following refund line applications.</p>
              <p style="margin-bottom:0;">Balance = Amount – Net
                Applied</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date when the refund was canceled. This parameter is required for void
              services.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Effective Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date when the cancellation of this refund takes effect.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Gateway Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date when the cancellation transaction was processed in the payment gateway.
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Gateway Reference Number</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The unique ID for the cancellation transaction generated by the payment gateway.
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Gateway Result Code</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The gateway-specific result code for the cancellation transaction.&nbsp;This result code is
              mapped to a Salesforce result code.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Cancellation Salesforce Result Code</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The Salesforce result code for the cancellation transaction</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Comments</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">Comments about the refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date when the refund was initiated.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Effective Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date when the refund application becomes effective.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Gateway Date</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The date that a successful gateway communication caused the creation of this
              refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Gateway Reference Number</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The unique transaction ID created by the payment gateway.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Gateway Result Code</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The gateway-specific result code for the refund transaction. This result code is
              mapped to a Salesforce result code.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Gateway Result Code Description</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The description of the gateway result code.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Impact Amount</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>Shows the refund’s financial impact against the customer’s accounts receivable. </p>
              <ul>
                <li>If the refund amount is valid, the impact amount is equal to the refund amount if the
                  refund amount is valid. </li>
                <li>If the refund amount is void, the impact amount is zero (0).</li>
                <li>If the refund is canceled, the impact amount is blank.</li>
              </ul>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">IP Address</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The IP address of the user who initiated the refund. </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">MAC Address</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The IP address of the user who initiated the refund. </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Net Applied</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>The net refund applied.</p>
              <p style="margin-bottom:0;">Net Applied = Total Applied - Total Unapplied</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Order Payment Summary </td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The order payment summary associated with the refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Payment Gateway</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The payment gateway used to process this refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Payment Group</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The payment group for the payment being refunded. </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Payment Method</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The payment method used to create the payment that is being refunded.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Phone</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The phone number of the customer who initiated the refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Processing Mode</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>Indicates whether the payment has been made outside of the payment
                platform.</p>
              <p>Possible values are:</p>
              <ul>
                <li>External - Transaction occurred outside of the Salesforce payment platform.</li>
                <li>Salesforce - Salesforce made and recorded an external call to the payment gateway.</li>
              </ul>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Refund Number</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The auto-generated ID number for the refund.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Salesforce Result Code</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>The Salesforce result code for the refund transaction. This value can be mapped to one
                or more gateway result codes.</p>
              <p>Possible values are:</p>
              <ul>
                <li>Decline—The gateway call failed, but it may still work if the transaction is attempted
                  again. For example, the customer had insufficient funds or briefly lost their
                  connection.</li>
                <li>Indeterminate—The gateway didn’t respond to the call. This response usually happens
                  when Salesforce times out while waiting for a response from the gateway.</li>
                <li>Permanent Fail: The gateway call failed and won’t work even if tried again. Gateway
                  calls fail permanently for one of two reasons:<ul class="simple">
                    <li>Hard Decline—The customer’s payment account has been closed or terminated.</li>
                    <li>Fraud—The gateway recognized the payment or payment method as known fraud</li>
                  </ul>
                </li>
                <li>Requires Review—The customer’s bank requires more information before completing the
                  payment.</li>
                <li>Success—The gateway call succeeded.</li>
                <li>System Error—Salesforce ended the payment request before receiving a response. For
                  example, Salesforce lost credentials or access to its server. Salesforce ends payment
                  calls if it doesn’t receive a response from the gateway within two minutes.</li>
                <li>Validation Error—Customer payment data was incorrect. For example, the payment was
                  submitted with a misspelling in the credit card address or an incorrect CVV.</li>
              </ul>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Status</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>Indicates the status of the refund transaction.</p>
              <p>Possible values are:</p>
              <ul>
                <li>Canceled—The refund has been voided and can no longer be allocated</li>
                <li>Draft—The refund can be edited before posting it and allocating it to a target.</li>
                <li>Failed—The authorization for the refund failed.</li>
                <li>Processed—The refund has been finalized and can be allocated against a target.</li>
              </ul>
            </td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Total Applied</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The total amount of the refund applied against an invoice.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Total Unapplied</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">The total amount of the refund that was previously applied against an invoice that has
              been unapplied.</td>

          </tr>
          <tr class="">
            <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e66 ">Type</td>

            <td data-label="Label" class="slds-cell-wrap" style="vertical-align:top;" headers="d24363e69 ">
              <p>Indicates how this refund is used.</p>
              <p>Possible values are:</p>
              <ul>
                <li>NonReferenced - Standalone refund not linked to a payment.</li>
                <li>Referenced - Refund made against a payment.</li>
              </ul>
            </td>

          </tr>
        </tbody>
      </table>

#### See Also

- [Order Management Objects and Fields](https://help.salesforce.com/s/articleView?id=commerce.om_order_management_objects_and_fields.htm&release=264.0.0&type=5 "Learn about the standard objects and fields available for reporting in Order Management.")