- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- ExecutionStatus
- Try it!
Capture funds from the customer for the current order total. This method should be called after the merchant verifies that they are able and ready to start shipping the order.
This method blocks until a response is received from the payment processsor. If this method succeeds, the merchant is guaranteed to receive funds for the order after shipment. If the request fails, it can be retried or the order may be cancelled.
This method cannot be called after the entire order is already shipped.
A rejected error code is returned when the payment service provider has declined the charge. This indicates a problem between the PSP and either the merchant's or customer's account. Sometimes this error will be resolved by the customer. We recommend retrying these errors once per day or cancelling the order with reason failedToCaptureFunds
if the items cannot be held.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orders/{orderId}/captureOrder
Path parameters
Parameters | |
---|---|
merchantId |
Required. The ID of the account that manages the order. This cannot be a multi-client account. |
orderId |
Required. The ID of the Order. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for the orders.captureOrder method.
JSON representation |
---|
{
"executionStatus": enum ( |
Fields | |
---|---|
executionStatus |
The status of the execution. Only defined if the request was successful. Acceptable values are:
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
ExecutionStatus
Returned for successful requests.
Enums | |
---|---|
EXECUTION_STATUS_UNSPECIFIED |
Default value. This value is unused. |
EXECUTED |
The request was completed successfully. |
DUPLICATE |
The request was not performed because it already executed once successfully. |