Skip to main content

Capture Order

Purpose: Requests the capture of the payment. This will result in the payout to the Merchant once Svea has confirmed that the delivery of goods or services has taken place. This is an asynchronous operation; the initial response indicates only that the request was received. Final status (Captured) is confirmed via a callback to the configured callbackUrl.

Endpoint Details​

  • HTTP Verb: POST
  • URL Segment: /v3/order/{orderId}/capture
  • OpenAPI Spec: View in Swagger UI
  • Notes: Returns a 202 Accepted status immediately. The order status changes to CaptureRequested. A subsequent successful capture is confirmed by a callback that updates the order status to Captured.

Path Parameters​

This method uses a parameter passed directly in the URL path.

Field NameDescriptionTypeAdditional Information
orderIdThe unique ID of the order to be captured.string ($uuid)Required. This is the orderId returned from Create Order.

Request Body​

No Request Body Required.

Successful Response (202 Accepted)​

The API returns an OrderResponse object containing the updated Order.

For schema and examples, see the OrderResponse Schema page.

Error Responses​

The following HTTP status codes are explicitly documented for this method:

Status CodeDescription
400 Bad RequestThe request was invalid (e.g., the order is not in an authorized state to be captured, or is already captured). Response body may contain an error message like "Failed validation context".
401 UnauthorizedAuthentication failure (e.g., missing or invalid API key/credentials).
404 Not FoundThe specified orderId does not exist.
412 Precondition FailedA client error indicating the order cannot be captured due to its current state. Often used when the order is not fully approved or if there's a financing conflict.