RefundTransaction
Use this procedure to refund a previously settled transaction. Refunds can only be issued for transactions that have already been settled; unsettled transactions must be voided instead.
Stored Procedure-Specific Information
To execute this stored procedure, enter:EXEC RefundTransaction RefTransId='1234567890', Amount='25.00', CurrencyCode='USD', CardNumber='1111', ExpirationDate='2025-12'
Input
| Name | Type | Required | Description |
| RefId | String | False | Merchant-assigned reference ID for the request. If included, this value is returned in the response. |
| Amount | Decimal | True | Amount to refund. This is the total amount and must include tax, shipping, and any other charges. The amount cannot exceed the original transaction amount. |
| CurrencyCode | String | False | The currency of the refund. |
| CardNumber | String | False | The customer's credit card number, or the last four digits of the credit card used in the original transaction. Required, together with ExpirationDate, to refund a credit card. Do not specify together with the bank account fields, which refund an eCheck.Net transaction instead. |
| ExpirationDate | String | False | The expiration date of the credit card used in the original transaction, in YYYY-MM format. Use XXXX if the expiration date is unknown. Required, together with CardNumber, to refund a credit card. |
| BankAccountType | String | False | The type of bank account used for the eCheck.Net refund. Possible values are checking, savings, and businessChecking. |
| RoutingNumber | String | False | The ABA routing number of the bank account used for the eCheck.Net refund. Do not specify together with CardNumber and ExpirationDate, which refund a credit card instead. |
| AccountNumber | String | False | The bank account number used for the eCheck.Net refund. Do not specify together with CardNumber and ExpirationDate, which refund a credit card instead. |
| NameOnAccount | String | False | The name of the person who holds the bank account used for the eCheck.Net refund. |
| EcheckType | String | False | The type of eCheck transaction. Possible values are PPD, WEB, CCD, TEL, ARC, and BOC. |
| BankName | String | False | The name of the bank associated with the bank account used for the eCheck.Net refund. |
| CheckNumber | String | False | The check number associated with the bank account used for the eCheck.Net refund. |
| TerminalNumber | String | False | The terminal number used for the transaction. |
| RefTransId | String | False | The payment gateway assigned identification number of the original transaction to refund. Required to refund a settled transaction; omit only when submitting an unlinked credit. |
| OrderInvoiceNumber | String | False | Merchant-defined invoice number associated with the order. |
| OrderDescription | String | False | Description of the item purchased. |
| LineItemId | String | False | Item identification. |
| LineItemName | String | False | Name of the item. |
| LineItemDescription | String | False | Description of the item. |
| LineItemQuantity | Decimal | False | Quantity purchased. |
| LineItemUnitPrice | Decimal | False | Price of one item per unit, excluding tax, freight, and duty. |
| LineItemTaxable | Boolean | False | Indicates whether the line item is taxable. |
| LineItemUnitOfMeasure | String | False | The unit of measure for the line item. |
| LineItemTaxAmount | Decimal | False | The tax amount for the line item. |
| LineItemCommodityCode | String | False | The commodity code for the line item. |
| LineItemProductCode | String | False | The product code for the line item. |
| LineItemProductSKU | String | False | The product SKU for the line item. |
| LineItemDiscountAmount | Decimal | False | The discount amount for the line item. |
| TaxAmount | Decimal | False | The tax amount for the order. |
| TaxName | String | False | The name of the tax for the order. |
| TaxDescription | String | False | The description of the tax for the order. |
| DutyAmount | Decimal | False | The duty amount for the order. |
| DutyName | String | False | The name of the duty for the order. |
| DutyDescription | String | False | The description of the duty for the order. |
| ShippingAmount | Decimal | False | The shipping charge amount for the order. |
| ShippingName | String | False | The name of the shipping charge for the order. |
| ShippingDescription | String | False | The description of the shipping charge for the order. |
| TaxExempt | Boolean | False | Indicates whether the transaction is tax exempt. |
| PONumber | String | False | The purchase order number. |
| CustomerType | String | False | The type of customer. Possible values are individual and business. |
| CustomerId | String | False | Merchant assigned customer ID. Unique identifier to represent the customer associated with the transaction. |
| CustomerEmail | String | False | The customer's email address. |
| BillToFirstName | String | False | First name associated with the customer's billing address. |
| BillToLastName | String | False | Last name associated with the customer's billing address. |
| BillToCompany | String | False | Company associated with the customer's billing address. |
| BillToAddress | String | False | Customer's billing address. |
| BillToCity | String | False | City of the customer's billing address. |
| BillToState | String | False | State of the customer's billing address. |
| BillToZip | String | False | ZIP code of the customer's billing address. |
| BillToCountry | String | False | Country of the customer's billing address. |
| BillToPhoneNumber | String | False | Phone number associated with the customer's billing address. |
| BillToFaxNumber | String | False | Fax number associated with the customer's billing address. |
| ShipToFirstName | String | False | First name associated with the customer's shipping address. |
| ShipToLastName | String | False | Last name associated with the customer's shipping address. |
| ShipToCompany | String | False | Company associated with the customer's shipping address. |
| ShipToAddress | String | False | Customer's shipping address. |
| ShipToCity | String | False | City of the customer's shipping address. |
| ShipToState | String | False | State of the customer's shipping address. |
| ShipToZip | String | False | ZIP code of the customer's shipping address. |
| ShipToCountry | String | False | Country of the customer's shipping address. |
| EmployeeId | String | False | The identifier of the employee processing the transaction. |
| TransactionSettingName | String | False | The name of a transaction setting. Allowed values include emailCustomer, merchantEmail, allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling, duplicateWindow, and testRequest. |
| TransactionSettingValue | String | False | The value of the transaction setting identified by TransactionSettingName. |
| UserFieldName | String | False | The name of a merchant-defined user field. |
| UserFieldValue | String | False | The value of the merchant-defined user field identified by UserFieldName. |
| SurchargeAmount | Decimal | False | The surcharge amount applied to the transaction. |
| SurchargeDescription | String | False | The description of the surcharge. |
| PurchaseLevel | String | False | The purchase level of the transaction data. |
Result Set Columns
| Name | Type | Description |
| RefId | String | Merchant-assigned reference ID for the request. |
| Code | String | Response code that represents the status. |
| Message | String | Text description of the status. |
| ResponseCode | Integer | Overall status of the transaction. Possible values are 1 = Approved, 2 = Declined, 3 = Error, 4 = Held for Review. |
| AuthCode | String | The authorization or approval code for the transaction. |
| AvsResultCode | String | Address Verification Service (AVS) response code. Indicates the result of the AVS filter. |
| CvvResultCode | String | Card code verification (CCV) response code. |
| CavvResultCode | String | Cardholder authentication verification value (CAVV) response code. |
| TransId | String | The payment gateway assigned identification number for the transaction. Use this value for any follow-on transactions such as a credit, prior authorization and capture, or void. |
| RefTransId | String | The transaction ID of a related, previously settled transaction. |
| TransHash | String | An MD5 hash used to authenticate the response. |
| AccountNumber | String | The masked account number used for the transaction. |
| AccountType | String | The account type used for the transaction. |
| ErrorCode | String | The error code returned when the transaction results in an error. |
| ErrorText | String | The text description of the error. |
| UserFieldName | String | The name of a merchant-defined user field returned in the response. |
| UserFieldValue | String | The value of the merchant-defined user field returned in the response. |
| TransHashSha2 | String | A SHA-256 hash used to authenticate the response. |