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, you'll receive 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
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.
Use this parameter if you would like to pass an
orderId different than that of the original transaction. Otherwise, the original transaction's
orderId 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('a_transaction_id', '50.00'); $result->success # true $result->transaction->type # 'credit' $result->transaction->amount # "50.00" $result = $gateway->transaction()->refund('a_transaction_id', '10.00'); $result->success # true $result->transaction->type # 'credit' $result->transaction->amount # "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 the processor declines the capture for the refund transaction, the transaction object will have the
$processorSettlementResponseCode available. See the transaction statuses page for additional information on the
Settlement Declined response.
$result->success # false $result->transaction->status # "settlement_declined" $result->transaction->processorSettlementResponseCode # e.g. 4001 $result->transaction->processorSettlementResponseText # e.g. "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->creditCard()->credit( 'the_token', ['amount' => '100.00'] );