See also the Transaction response object.
You can refund transactions that have a status of settled or settling. If the transaction has not yet begun settlement, use Transaction: Void instead. If you do not specify an amount to refund, the entire transaction amount will be refunded.
result = gateway.transaction.refund("the_transaction_id")
If the transaction can't be found, it will raise a
If the refund fails, then the result will be unsuccessful and will include either validation errors indicating which parameters were invalid, or a processor settlement response code indicating the type of settlement failure.
result.success? #=> false p result.errors
The amount to refund. This value must be greater than 0, and can't exceed the total amount of the transaction. If you do not specify an amount to refund, the entire transaction amount will be refunded. See partial refunds below for more details.
The line items for this transaction. It can include up to 249 line items. ** Only available for Custom Actions transactions. **
Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used. Maximum 12 characters. This Braintree line-item field is not used by PayPal.
Discount amount for the line item. Can include up to 2 decimal places. This value can't be negative. This Braintree line-item field is not used by PayPal.
Indicates whether the line item is a debit (sale) or credit (refund) to the customer. Accepted values:
Number of units of the item purchased. Can include up to 4 decimal places. This value can't be negative or zero.
Per-unit price of the item. Maximum 4 decimal places. This value can't be negative or zero.
The unit of measure or the unit of measure code. Maximum 12 characters. This Braintree line-item field is not used by PayPal.
Per-unit tax price of the item. Can include up to 2 decimal places. This value can't be negative or zero.
Use this parameter if you would like to pass an
order_id different than that of the original transaction. Otherwise, the original transaction's
order_id value will be copied over to the refund. On PayPal transactions, this field maps to the PayPal invoice number. PayPal invoice numbers must be unique in your PayPal business account. Maximum 255 characters or 127 for PayPal transactions.
- Transaction status must be settled or settling.
- Refund amount can't be greater than remaining non-refunded amount of the original transaction.
- Transaction can't be refunded again after being completely refunded.
- Transactions held in escrow can only be refunded in full. Attempts to partially refund an escrow transaction will throw a validation error.
If you only want to refund a portion of the transaction, specify the amount to refund:
result = gateway.transaction.refund("j59qrb", "50.00") result.success? #=> true result.transaction.amount.to_f #=> 50.00 result = gateway.transaction.refund("j59qrb", "10.00") result.success? #=> true result.transaction.amount.to_f #=> 10.00
We support single and multiple partial refunds on a given transaction. You can continue to refund a transaction as many times as you like, as long as the sum of the refund amounts is less than the amount of the initial transaction.
If you have already partially refunded a transaction and you perform another refund without specifying the balance, we will refund the remaining non-refunded amount of the transaction.
If using the most current SDK, and the processor declines the refund, the response will have the
processor_response_code available. See the transaction statuses page for additional information on the Processor Declined response. If using an older SDK version, and the processor declines the refund, you may receive a validation error in lieu of a processor response code.
result.success? #=> false result.transaction.status #=> "processor_declined" result.transaction.processor_response_code #=> "2005" result.transaction.processor_response_text #=> "Invalid Credit Card Number"
If the processor declines the capture for the refund transaction, the transaction object will have the
processor_settlement_response_code available. See the transaction statuses page for additional information on the
Settlement Declined response.
result.success? #=> false result.transaction.status #=> "settlement_declined" result.transaction.processor_settlement_response_code #=> "4001" result.transaction.processor_settlement_response_text #=> "Settlement Declined"
You can use credit transactions to give a customer money. However, you should refund to an existing payment method whenever possible.
The only required parameters to create a credit transaction are the amount and the payment method token.
result = gateway.credit_card.credit( "the_token", :amount => "100.00" )