Authorise and capture payments

This page describes how to authorise a customer's card for an amount, which will reserve the amount on the card for a few days. This page also describes how you can then capture an approved pre-authorisation to collect the funds or reverse it to release the funds.

We recommend that you capture (or reverse) a pre-authorisation within 7 days. However, the cardholder's issuing bank decides how long to hold the funds.

You will need:

• One or more single payment products, see Create a single payment product, or an instalment product with an unlocked payment configuration.
  • To use an instalment product, deselect the Split Payments option because this option is not compatible with the pre-authorise option.
• A customer or their details to enter when creating an order (at least the name and email address are required).

How to authorise and capture a payment

To hold funds on a customer's card for later collection, do these steps.

1. Create a new order. For example, you can click + and select Add Order.
2. Select or add your customer.
3. Select one or more single-payment products and enter a quantity and a price, then set pricing options.
4. Optionally, select the checkbox to Save Card Details.
5. Select the Pre-authorise option.

   

6. Click Create Order and send a payment link or enter card details over the phone.
7. If the pre-authorisation is approved, the order status becomes Active. The approved transaction with the type of PA is in the Related Transactions list. To collect the authorised amount, click the round arrow button to Capture the payment.

   

8. You can capture a payment once only, for the full amount or enter a partial amount. Click Capture Now to charge the amount to the customer's card.

   

After the capture is processed, the order status becomes Complete.

The capture transaction appears in the Related Transactions list with the transaction type of CP for CardCorp or DB for Stripe. You can use the round-arrow Refund button to make a full or partial refund, as for any debit (DB) transaction. We recommend that you make a full refund.

How to reverse an authorisation

For current authorisation, you can use the Refund option to reverse the authorisation and release the funds held on the customer's card. The time that the funds are held before they are released automatically depends on the issuing bank, but it is usually about a week. We recommend that you always use a full reversal.

After you authorise a payment, to release the amount held on the customer's card, do these steps.

1. In the order, go to Related Transactions and find the PA authorisation transaction.

   

2. Click the round-arrow Refund button beside the the payment to reverse the pre-authorisation.
3. You can reverse the full amount only.
4. After you reverse the authorisation, the order status becomes Complete.

The reversal transaction displays in the Related Transactions list and the amount reversed will be returned to the customer's card within a few days at the most.