Transaction
Transaction: Void
You can void transactions that have a status of authorized, submitted for settlement, or - for PayPal - settlement pending. The only required information is the transaction ID. When the transaction is voided, we will perform an authorization reversal, if possible, to remove the pending charge from the customer's card.
Refer to the Transaction response object for more information.
- Ruby
result = gateway.transaction.void("the_transaction_id")
The result will return true if the transaction is successfully voided. Otherwise, check for validation errors.
- Ruby
if result.success?
# transaction successfully voided
else
p result.errors
end
Arguments
transaction_id
required, StringThe unique transaction identifier. You can only void transactions that have a of:
- authorized
- submitted_for_settlement
- settlement_pending (only for certain PayPal transactions)