You are here:
Refund Fields
The Refund object represents a single refund transaction.
Required Editions
| View supported editions. |
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.
| Field | Label |
|---|---|
| Account | The customer account containing the payment that this refund targets. |
| Amount | Total amount of this refund. |
| Audit Email | The email address of the customer who initiated the refund. |
| Balance | Remaining balance following refund line applications. Balance = Amount – Net Applied |
| Cancellation Date | The date when the refund was canceled. This parameter is required for void services. |
| Cancellation Effective Date | The date when the cancellation of this refund takes effect. |
| Cancellation Gateway Date | The date when the cancellation transaction was processed in the payment gateway. |
| Cancellation Gateway Reference Number | The unique ID for the cancellation transaction generated by the payment gateway. |
| Cancellation Gateway Result Code | The gateway-specific result code for the cancellation transaction. This result code is mapped to a Salesforce result code. |
| Cancellation Salesforce Result Code | The Salesforce result code for the cancellation transaction |
| Comments | Comments about the refund. |
| Date | The date when the refund was initiated. |
| Effective Date | The date when the refund application becomes effective. |
| Gateway Date | The date that a successful gateway communication caused the creation of this refund. |
| Gateway Reference Number | The unique transaction ID created by the payment gateway. |
| Gateway Result Code | The gateway-specific result code for the refund transaction. This result code is mapped to a Salesforce result code. |
| Gateway Result Code Description | The description of the gateway result code. |
| Impact Amount | Shows the refund’s financial impact against the customer’s accounts receivable.
|
| IP Address | The IP address of the user who initiated the refund. |
| MAC Address | The IP address of the user who initiated the refund. |
| Net Applied | The net refund applied. Net Applied = Total Applied - Total Unapplied |
| Order Payment Summary | The order payment summary associated with the refund. |
| Payment Gateway | The payment gateway used to process this refund. |
| Payment Group | The payment group for the payment being refunded. |
| Payment Method | The payment method used to create the payment that is being refunded. |
| Phone | The phone number of the customer who initiated the refund. |
| Processing Mode | Indicates whether the payment has been made outside of the payment platform. Possible values are:
|
| Refund Number | The auto-generated ID number for the refund. |
| Salesforce Result Code | The Salesforce result code for the refund transaction. This value can be mapped to one or more gateway result codes. Possible values are:
|
| Status | Indicates the status of the refund transaction. Possible values are:
|
| Total Applied | The total amount of the refund applied against an invoice. |
| Total Unapplied | The total amount of the refund that was previously applied against an invoice that has been unapplied. |
| Type | Indicates how this refund is used. Possible values are:
|
Did this article solve your issue?
Let us know so we can improve!

