Reserve and capture
When you initiate a payment, it will be reserved until you capture it:
- When a payment is reserved it means the customer has approved the payment. The funds are still in the customer's account, but not available to spend on other things.
- When a payment is captured it means the funds are moved from customer's account to merchant's account.
- Captured funds will be settled to the merchant's settlement account after two business days. See Settlement Information for more details.
We support both reserve capture and direct capture:
- Reserve capture is the default, and works for all types if payments. When you initiate a payment, it will be reserved until you capture it. The capture can be done a few seconds later, or several days later.
- Direct capture is available in the eCom API for historical reasons, but not available in the newer ePayment API. When direct capture is configured for a sales unit, all payment reservations will instantly be captured, without the need for a separate capture request. This is provided for legacy reasons and was intended for situations where the product or service is immediately provided to the customer, and there is absolutely no chance that the service is not available or sold out, e.g. digital services. We have since moved away from this, and strongly recommend that all integrations use the ePayment API and reserve capture. Direct capture requires additional compliance checks of the merchant.
Important: It's completely fine to use reserve capture almost exactly like direct capture: Just do the capture immediately after the reservation. The user experience is exactly the same.
Important things to consider for cancellations and refunds:
- If a payment has been reserved (as with "reserve capture"), the merchant can make a "cancel" API request to immediately release the reservation and make available in the customer's account. This may be useful even in situations where it's "impossible" that the goods/service is sold out.
- If a payment has been captured (as with "direct capture"), the merchant has to make a "refund" API request, and it then takes several days before the amount is available in the customer's account.
- With "reserve capture" it is possible to reserve a higher amount and only capture a part of it (useful for electric car charging stations, etc.). It is also possible to capture the full amount with multiple captures ("partial capture").
This is applicable to:
When the user confirms the purchase in the app, the payment status changes to
The respective amount will be reserved for capture, which may be done immediately or later.
See the FAQ:
There are three types of capture:
These are described in more detail below.
Always use an idempotency key in the capture call.
To perform a capture of the entire amount owed, the
amount can be
omitted from the API request (i.e., not sent at all), set to
null or set to
When doing a partial capture, you need to specify the amount.
Please note: It is important to check the response of the capture
call. The capture is only successful when the response is
HTTP 200 OK.
Payment capture can be made up to 180 days after reservation.
Attempting to capture an older payment will result in a
HTTP 400 Bad Request.
See the FAQ:
- When should I charge the customer?
- What is the difference between "Reserve Capture" and "Direct Capture"?
- When should I use "Direct Capture"?
_Reserve capture* is the normal flow.
When the end user approves an initiated payment, it will be reserved until you capture it. When the order is reserved, the amount is marked as reserved by the bank, but not transferred.
When direct capture is activated, all payment reservations will instantly be captured.
With direct capture, Vipps MobilePay is responsible for the customer receiving the purchased product. Because of this, direct capture requires additional compliance checks.
A sales unit can only have one capture type, and it must be configured by Vipps MobilePay. You can't turn direct capture on or off as a merchant.
We strongly recommend using "reserve capture" in all situations.
Please note: We only offer "direct capture" for merchants that use Vipps MobilePay through a partner, and for merchants that have a Key Account Manager. "Direct capture" must be requested by the partner from the partner manager, or by KAM merchants from the Key Account Manager.
Please note: The Checkout API does not support "direct capture".
See the FAQ:
Partial capture may be used in cases where a partial order is shipped or for other reasons.
Partial capture may be called as many times as required while there is a remaining amount that is reserved and has not yet been captured.
For the eCom API, it is also possible to do a partial capture and send an optional parameter to explicitly free the remaining amount immediately.