com.paypal.sdk.controllers

Class PaymentsController

java.lang.Object

com.paypal.sdk.controllers.BaseController

com.paypal.sdk.controllers.PaymentsController

public final class PaymentsController
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
PaymentsController(io.apimatic.core.GlobalConfiguration globalConfig) Initializes the controller.

Method Summary

Modifier and Type	Method and Description
ApiResponse<CapturedPayment>	captureAuthorizedPayment(CaptureAuthorizedPaymentInput input) Captures an authorized payment, by ID.
CompletableFuture<ApiResponse<CapturedPayment>>	captureAuthorizedPaymentAsync(CaptureAuthorizedPaymentInput input) Captures an authorized payment, by ID.
ApiResponse<PaymentAuthorization>	getAuthorizedPayment(GetAuthorizedPaymentInput input) Shows details for an authorized payment, by ID.
CompletableFuture<ApiResponse<PaymentAuthorization>>	getAuthorizedPaymentAsync(GetAuthorizedPaymentInput input) Shows details for an authorized payment, by ID.
ApiResponse<CapturedPayment>	getCapturedPayment(GetCapturedPaymentInput input) Shows details for a captured payment, by ID.
CompletableFuture<ApiResponse<CapturedPayment>>	getCapturedPaymentAsync(GetCapturedPaymentInput input) Shows details for a captured payment, by ID.
ApiResponse<Refund>	getRefund(GetRefundInput input) Shows details for a refund, by ID.
CompletableFuture<ApiResponse<Refund>>	getRefundAsync(GetRefundInput input) Shows details for a refund, by ID.
ApiResponse<PaymentAuthorization>	reauthorizePayment(ReauthorizePaymentInput input) Reauthorizes an authorized PayPal account payment, by ID.
CompletableFuture<ApiResponse<PaymentAuthorization>>	reauthorizePaymentAsync(ReauthorizePaymentInput input) Reauthorizes an authorized PayPal account payment, by ID.
ApiResponse<Refund>	refundCapturedPayment(RefundCapturedPaymentInput input) Refunds a captured payment, by ID.
CompletableFuture<ApiResponse<Refund>>	refundCapturedPaymentAsync(RefundCapturedPaymentInput input) Refunds a captured payment, by ID.
ApiResponse<PaymentAuthorization>	voidPayment(VoidPaymentInput input) Voids, or cancels, an authorized payment, by ID.
CompletableFuture<ApiResponse<PaymentAuthorization>>	voidPaymentAsync(VoidPaymentInput input) Voids, or cancels, an authorized payment, 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

PaymentsController

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

Initializes the controller.

Parameters:

globalConfig - Configurations added in client.

Method Detail

getAuthorizedPayment

public ApiResponse<PaymentAuthorization> getAuthorizedPayment(GetAuthorizedPaymentInput input)
                                                       throws ApiException,
                                                              IOException

Shows details for an authorized payment, by ID.

Parameters:

input - GetAuthorizedPaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization 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.

getAuthorizedPaymentAsync

public CompletableFuture<ApiResponse<PaymentAuthorization>> getAuthorizedPaymentAsync(GetAuthorizedPaymentInput input)

Shows details for an authorized payment, by ID.

Parameters:

input - GetAuthorizedPaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization wrapped in ApiResponse response from the API call

captureAuthorizedPayment

public ApiResponse<CapturedPayment> captureAuthorizedPayment(CaptureAuthorizedPaymentInput input)
                                                      throws ApiException,
                                                             IOException

Captures an authorized payment, by ID.

Parameters:

input - CaptureAuthorizedPaymentInput object containing request parameters

Returns:

Returns the CapturedPayment 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.

captureAuthorizedPaymentAsync

public CompletableFuture<ApiResponse<CapturedPayment>> captureAuthorizedPaymentAsync(CaptureAuthorizedPaymentInput input)

Captures an authorized payment, by ID.

Parameters:

input - CaptureAuthorizedPaymentInput object containing request parameters

Returns:

Returns the CapturedPayment wrapped in ApiResponse response from the API call

reauthorizePayment

public ApiResponse<PaymentAuthorization> reauthorizePayment(ReauthorizePaymentInput input)
                                                     throws ApiException,
                                                            IOException

Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires. If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment. A reauthorized payment itself has a new honor period of three days. You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only the `amount` request parameter. Note: This request is currently not supported for Partner use cases.

Parameters:

input - ReauthorizePaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization 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.

reauthorizePaymentAsync

public CompletableFuture<ApiResponse<PaymentAuthorization>> reauthorizePaymentAsync(ReauthorizePaymentInput input)

Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires. If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment. A reauthorized payment itself has a new honor period of three days. You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD. Supports only the `amount` request parameter. Note: This request is currently not supported for Partner use cases.

Parameters:

input - ReauthorizePaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization wrapped in ApiResponse response from the API call

voidPayment

public ApiResponse<PaymentAuthorization> voidPayment(VoidPaymentInput input)
                                              throws ApiException,
                                                     IOException

Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

Parameters:

input - VoidPaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization 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.

voidPaymentAsync

public CompletableFuture<ApiResponse<PaymentAuthorization>> voidPaymentAsync(VoidPaymentInput input)

Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

Parameters:

input - VoidPaymentInput object containing request parameters

Returns:

Returns the PaymentAuthorization wrapped in ApiResponse response from the API call

getCapturedPayment

public ApiResponse<CapturedPayment> getCapturedPayment(GetCapturedPaymentInput input)
                                                throws ApiException,
                                                       IOException

Shows details for a captured payment, by ID.

Parameters:

input - GetCapturedPaymentInput object containing request parameters

Returns:

Returns the CapturedPayment 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.

getCapturedPaymentAsync

public CompletableFuture<ApiResponse<CapturedPayment>> getCapturedPaymentAsync(GetCapturedPaymentInput input)

Shows details for a captured payment, by ID.

Parameters:

input - GetCapturedPaymentInput object containing request parameters

Returns:

Returns the CapturedPayment wrapped in ApiResponse response from the API call

refundCapturedPayment

public ApiResponse<Refund> refundCapturedPayment(RefundCapturedPaymentInput input)
                                          throws ApiException,
                                                 IOException

Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

Parameters:

input - RefundCapturedPaymentInput object containing request parameters

Returns:

Returns the Refund 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.

refundCapturedPaymentAsync

public CompletableFuture<ApiResponse<Refund>> refundCapturedPaymentAsync(RefundCapturedPaymentInput input)

Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

Parameters:

input - RefundCapturedPaymentInput object containing request parameters

Returns:

Returns the Refund wrapped in ApiResponse response from the API call

getRefund

public ApiResponse<Refund> getRefund(GetRefundInput input)
                              throws ApiException,
                                     IOException

Shows details for a refund, by ID.

Parameters:

input - GetRefundInput object containing request parameters

Returns:

Returns the Refund 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.

getRefundAsync

public CompletableFuture<ApiResponse<Refund>> getRefundAsync(GetRefundInput input)

Shows details for a refund, by ID.

Parameters:

input - GetRefundInput object containing request parameters

Returns:

Returns the Refund wrapped in ApiResponse response from the API call