C# Class PayPal.Api.Order

An order transaction.

See PayPal Developer documentation for more information.

Inheritance: PayPalRelationalObject

Show file Open project: paypal/PayPal-NET-SDK Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Authorize ( APIContext apiContext ) : Authorization	Authorizes an order, by ID. Include an `amount` object in the JSON request body.
Authorize ( APIContext apiContext, Order order ) : Authorization	Creates an authorization on an order
Capture ( APIContext apiContext, Capture capture ) : Capture	Captures a payment for an order, by ID. To use this call, the original payment call must specify an intent of `order`. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.
Capture ( APIContext apiContext, string orderId, Capture capture ) : Capture	Creates (and processes) a new Capture Transaction added as a related resource.
Get ( APIContext apiContext, string orderId ) : Order	Shows details for an order, by ID.
Void ( APIContext apiContext ) : Order	Voids, or cancels, an order, by ID. You cannot void an order if a payment has already been partially or fully captured.
Void ( APIContext apiContext, string orderId ) : Order	Voids (cancels) an Order.

Method Details

Authorize() public method

Authorizes an order, by ID. Include an `amount` object in the JSON request body.

public Authorize ( APIContext apiContext ) : Authorization
apiContext	APIContext	APIContext used for the API call.
return	Authorization

Authorize() public static method

Creates an authorization on an order

public static Authorize ( APIContext apiContext, Order order ) : Authorization
apiContext	APIContext	APIContext used for the API call.
order	Order	Order object to authorize.
return	Authorization

Capture() public method

Captures a payment for an order, by ID. To use this call, the original payment call must specify an intent of `order`. In the JSON request body, include the payment amount and indicate whether this capture is the final capture for the authorization.

public Capture ( APIContext apiContext, Capture capture ) : Capture
apiContext	APIContext	APIContext used for the API call.
capture	Capture	Capture
return	Capture

Capture() public static method

Creates (and processes) a new Capture Transaction added as a related resource.

public static Capture ( APIContext apiContext, string orderId, Capture capture ) : Capture
apiContext	APIContext	APIContext used for the API call.
orderId	string	ID of the order to capture.
capture	Capture	Capture
return	Capture

Get() public static method

Shows details for an order, by ID.

public static Get ( APIContext apiContext, string orderId ) : Order
apiContext	APIContext	APIContext used for the API call.
orderId	string	The ID of the order for which to show details.
return	Order

Void() public method

Voids, or cancels, an order, by ID. You cannot void an order if a payment has already been partially or fully captured.

public Void ( APIContext apiContext ) : Order
apiContext	APIContext	APIContext used for the API call.
return	Order

Void() public static method

Voids (cancels) an Order.

public static Void ( APIContext apiContext, string orderId ) : Order
apiContext	APIContext	APIContext used for the API call.
orderId	string	ID of the order to void.
return	Order