Voiding a payment is an essential function that allows Main Account holders to cancel a payment before it is fully processed, ensuring that funds are not captured or settled.
For all payments routed under the Main Account holder, and therefore of type Single Payment, or Recurring Payments and Unscheduled Payments without a Sub-Account involved, Main Account holders have the ability to void payments using either the Ryft Dashboard or the Ryft API.
For any other payment types and payments involving Sub-Accounts, voiding can only be done through the Ryft API via the paymentSessionVoidById endpoint.
A payment can only be voided if it has been authorized but not yet captured or settled. Payments that have already been captured or settled cannot be voided and require a refund instead.
By default, unless otherwise specified in the Payment Session, payments are automatically authorized and captured in a single step. This means that such payments cannot be voided. In order to initiate a payment that can be voided, please follow the instructions in the Authorize Only Payments section.
Payments that have been authorized but not yet captured will typically have a status of Approved in the Payment Session, and will show as Not Captured in the Ryft Portal.
To void a payment using the Ryft Portal, you can select the payment you wish to void from the list of payments under the Payments page.
If the payment is in a Not Captured state and therefore eligible for voiding, you will see a Void Payment button available. Clicking this button will initiate the void process.
Please note that when voiding a payment, the following considerations apply:
- Authorized payments can only be voided by the Main Account holder. Sub-accounts do not have the capability to void payments.
- Once a payment has been successfully voided, its status will be updated to Voided, and it will no longer be eligible for capturing or settlement.
- Voiding a payment does not generate a refund, as the funds were never captured. If a payment has already been captured or settled, you will need to process a refund instead.
- The timeframe for voiding a payment may vary depending on the payment method and the policies of the acquiring bank. Please refer to the Authorization Validity section for more information on authorization timeframes.