Class OrdersResource.CaptureOrderRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CaptureOrderResponse>
ShoppingContentBaseServiceRequest<CaptureOrderResponse>
OrdersResource.CaptureOrderRequest
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class OrdersResource.CaptureOrderRequest : ShoppingContentBaseServiceRequest<CaptureOrderResponse>, IClientServiceRequest<CaptureOrderResponse>, IClientServiceRequest

Constructors

CaptureOrderRequest(IClientService, CaptureOrderRequest, long, string)

Constructs a new CaptureOrder request.

Declaration
public CaptureOrderRequest(IClientService service, CaptureOrderRequest body, long merchantId, string orderId)
Parameters
Type Name Description
IClientService service
CaptureOrderRequest body
long merchantId
string orderId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MerchantId

Required. The ID of the account that manages the order. This cannot be a multi-client account.

Declaration
[RequestParameter("merchantId", RequestParameterType.Path)]
public virtual long MerchantId { get; }
Property Value
Type Description
long

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderId

Required. The ID of the Order.

Declaration
[RequestParameter("orderId", RequestParameterType.Path)]
public virtual string OrderId { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes CaptureOrder parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements