com.paypal.sdk.controllers

Class OrdersController

java.lang.Object

com.paypal.sdk.controllers.BaseController

com.paypal.sdk.controllers.OrdersController

public final class OrdersController
extends BaseController

This class lists all the endpoints of the groups.

Field Summary

Fields inherited from class com.paypal.sdk.controllers.BaseController

GLOBAL_ERROR_CASES

Constructor Summary

Constructors

Constructor and Description
OrdersController(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
ApiResponse<OrderAuthorizeResponse>	authorizeOrder(AuthorizeOrderInput input) Authorizes payment for an order.
CompletableFuture<ApiResponse<OrderAuthorizeResponse>>	authorizeOrderAsync(AuthorizeOrderInput input) Authorizes payment for an order.
ApiResponse<Order>	captureOrder(CaptureOrderInput input) Captures payment for an order.
CompletableFuture<ApiResponse<Order>>	captureOrderAsync(CaptureOrderInput input) Captures payment for an order.
ApiResponse<Order>	confirmOrder(ConfirmOrderInput input) Payer confirms their intent to pay for the the Order with the given payment source.
CompletableFuture<ApiResponse<Order>>	confirmOrderAsync(ConfirmOrderInput input) Payer confirms their intent to pay for the the Order with the given payment source.
ApiResponse<Order>	createOrder(CreateOrderInput input) Creates an order.
CompletableFuture<ApiResponse<Order>>	createOrderAsync(CreateOrderInput input) Creates an order.
ApiResponse<Order>	createOrderTracking(CreateOrderTrackingInput input) Adds tracking information for an Order.
CompletableFuture<ApiResponse<Order>>	createOrderTrackingAsync(CreateOrderTrackingInput input) Adds tracking information for an Order.
ApiResponse<Order>	getOrder(GetOrderInput input) Shows details for an order, by ID.
CompletableFuture<ApiResponse<Order>>	getOrderAsync(GetOrderInput input) Shows details for an order, by ID.
ApiResponse<Void>	patchOrder(PatchOrderInput input) Updates an order with a `CREATED` or `APPROVED` status.
CompletableFuture<ApiResponse<Void>>	patchOrderAsync(PatchOrderInput input) Updates an order with a `CREATED` or `APPROVED` status.
ApiResponse<Void>	updateOrderTracking(UpdateOrderTrackingInput input) Updates or cancels the tracking information for a PayPal order, by ID.
CompletableFuture<ApiResponse<Void>>	updateOrderTrackingAsync(UpdateOrderTrackingInput input) Updates or cancels the tracking information for a PayPal order, by ID.

Methods inherited from class com.paypal.sdk.controllers.BaseController

getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrdersController

public OrdersController(io.apimatic.core.GlobalConfiguration globalConfig)

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

createOrder

public ApiResponse<Order> createOrder(CreateOrderInput input)
                               throws ApiException,
                                      IOException

Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - CreateOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createOrderAsync

public CompletableFuture<ApiResponse<Order>> createOrderAsync(CreateOrderInput input)

Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - CreateOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

getOrder

public ApiResponse<Order> getOrder(GetOrderInput input)
                            throws ApiException,
                                   IOException

Shows details for an order, by ID. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - GetOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getOrderAsync

public CompletableFuture<ApiResponse<Order>> getOrderAsync(GetOrderInput input)

Shows details for an order, by ID. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - GetOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

patchOrder

public ApiResponse<Void> patchOrder(PatchOrderInput input)
                             throws ApiException,
                                    IOException

Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status. To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: \\"/purchase_units/@reference_id=='default'/{attribute-or-object}\\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. Note: For error handling and troubleshooting, see Orders v2 errors. Patchable attributes or objects: Attribute Op Notes intent replace payer replace, add Using replace op for payer will replace the whole payer object with the value sent in request. purchase_units replace, add purchase_units[].custom_id replace, add, remove purchase_units[].description replace, add, remove purchase_units[].payee.email replace purchase_units[].shipping.name replace, add purchase_units[].shipping.email_address replace, add purchase_units[].shipping.phone_number replace, add purchase_units[].shipping.options replace, add purchase_units[].shipping.address replace, add purchase_units[].shipping.type replace, add purchase_units[].soft_descriptor replace, remove purchase_units[].amount replace purchase_units[].items replace, add, remove purchase_units[].invoice_id replace, add, remove purchase_units[].payment_instruction replace purchase_units[].payment_instruction.disbursement_mode replace By default, disbursement_mode is INSTANT. purchase_units[].payment_instruction.payee_receivable_fx_rate_id replace, add, remove purchase_units[].payment_instruction.platform_fees replace, add, remove purchase_units[].supplementary_data.airline replace, add, remove purchase_units[].supplementary_data.card replace, add, remove application_context.client_configuration replace, add.

Parameters:

input - PatchOrderInput object containing request parameters

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

patchOrderAsync

public CompletableFuture<ApiResponse<Void>> patchOrderAsync(PatchOrderInput input)

Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status. To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: \\"/purchase_units/@reference_id=='default'/{attribute-or-object}\\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout. Note: For error handling and troubleshooting, see Orders v2 errors. Patchable attributes or objects: Attribute Op Notes intent replace payer replace, add Using replace op for payer will replace the whole payer object with the value sent in request. purchase_units replace, add purchase_units[].custom_id replace, add, remove purchase_units[].description replace, add, remove purchase_units[].payee.email replace purchase_units[].shipping.name replace, add purchase_units[].shipping.email_address replace, add purchase_units[].shipping.phone_number replace, add purchase_units[].shipping.options replace, add purchase_units[].shipping.address replace, add purchase_units[].shipping.type replace, add purchase_units[].soft_descriptor replace, remove purchase_units[].amount replace purchase_units[].items replace, add, remove purchase_units[].invoice_id replace, add, remove purchase_units[].payment_instruction replace purchase_units[].payment_instruction.disbursement_mode replace By default, disbursement_mode is INSTANT. purchase_units[].payment_instruction.payee_receivable_fx_rate_id replace, add, remove purchase_units[].payment_instruction.platform_fees replace, add, remove purchase_units[].supplementary_data.airline replace, add, remove purchase_units[].supplementary_data.card replace, add, remove application_context.client_configuration replace, add.

Parameters:

input - PatchOrderInput object containing request parameters

Returns:

Returns the Void wrapped in ApiResponse response from the API call

confirmOrder

public ApiResponse<Order> confirmOrder(ConfirmOrderInput input)
                                throws ApiException,
                                       IOException

Payer confirms their intent to pay for the the Order with the given payment source.

Parameters:

input - ConfirmOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

confirmOrderAsync

public CompletableFuture<ApiResponse<Order>> confirmOrderAsync(ConfirmOrderInput input)

Payer confirms their intent to pay for the the Order with the given payment source.

Parameters:

input - ConfirmOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

authorizeOrder

public ApiResponse<OrderAuthorizeResponse> authorizeOrder(AuthorizeOrderInput input)
                                                   throws ApiException,
                                                          IOException

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - AuthorizeOrderInput object containing request parameters

Returns:

Returns the OrderAuthorizeResponse wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

authorizeOrderAsync

public CompletableFuture<ApiResponse<OrderAuthorizeResponse>> authorizeOrderAsync(AuthorizeOrderInput input)

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - AuthorizeOrderInput object containing request parameters

Returns:

Returns the OrderAuthorizeResponse wrapped in ApiResponse response from the API call

captureOrder

public ApiResponse<Order> captureOrder(CaptureOrderInput input)
                                throws ApiException,
                                       IOException

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - CaptureOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

captureOrderAsync

public CompletableFuture<ApiResponse<Order>> captureOrderAsync(CaptureOrderInput input)

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response. Note: For error handling and troubleshooting, see Orders v2 errors.

Parameters:

input - CaptureOrderInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

createOrderTracking

public ApiResponse<Order> createOrderTracking(CreateOrderTrackingInput input)
                                       throws ApiException,
                                              IOException

Adds tracking information for an Order.

Parameters:

input - CreateOrderTrackingInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createOrderTrackingAsync

public CompletableFuture<ApiResponse<Order>> createOrderTrackingAsync(CreateOrderTrackingInput input)

Adds tracking information for an Order.

Parameters:

input - CreateOrderTrackingInput object containing request parameters

Returns:

Returns the Order wrapped in ApiResponse response from the API call

updateOrderTracking

public ApiResponse<Void> updateOrderTracking(UpdateOrderTrackingInput input)
                                      throws ApiException,
                                             IOException

Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects: Attribute Op Notes items replace Using replace op for items will replace the entire items object with the value sent in request. notify_payer replace, add status replace Only patching status to CANCELLED is currently supported.

Parameters:

input - UpdateOrderTrackingInput object containing request parameters

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateOrderTrackingAsync

public CompletableFuture<ApiResponse<Void>> updateOrderTrackingAsync(UpdateOrderTrackingInput input)

Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects: Attribute Op Notes items replace Using replace op for items will replace the entire items object with the value sent in request. notify_payer replace, add status replace Only patching status to CANCELLED is currently supported.

Parameters:

input - UpdateOrderTrackingInput object containing request parameters

Returns:

Returns the Void wrapped in ApiResponse response from the API call