Api

Class PaymentsApi

java.lang.Object

Api.PaymentsApi

public class PaymentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentsApi()
PaymentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PtsV2PaymentsPost201Response	createPayment(CreatePaymentRequest createPaymentRequest) Process a Payment A payment authorizes the amount for the transaction.
okhttp3.Call	createPaymentAsync(CreatePaymentRequest createPaymentRequest, ApiCallback<PtsV2PaymentsPost201Response> callback) Process a Payment (asynchronously) A payment authorizes the amount for the transaction.
okhttp3.Call	createPaymentCall(CreatePaymentRequest createPaymentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createPayment
ApiResponse<PtsV2PaymentsPost201Response>	createPaymentWithHttpInfo(CreatePaymentRequest createPaymentRequest) Process a Payment A payment authorizes the amount for the transaction.
ApiClient	getApiClient()
PtsV2IncrementalAuthorizationPatch201Response	incrementAuth(String id, IncrementAuthRequest incrementAuthRequest) Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction.
okhttp3.Call	incrementAuthAsync(String id, IncrementAuthRequest incrementAuthRequest, ApiCallback<PtsV2IncrementalAuthorizationPatch201Response> callback) Increment an Authorization (asynchronously) Use this service to authorize additional charges in a lodging or autorental transaction.
okhttp3.Call	incrementAuthCall(String id, IncrementAuthRequest incrementAuthRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for incrementAuth
ApiResponse<PtsV2IncrementalAuthorizationPatch201Response>	incrementAuthWithHttpInfo(String id, IncrementAuthRequest incrementAuthRequest) Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction.
PtsV2PaymentsPost201Response1	refreshPaymentStatus(String id, RefreshPaymentStatusRequest refreshPaymentStatusRequest) Check a Payment Status Checks and updates the payment status
okhttp3.Call	refreshPaymentStatusAsync(String id, RefreshPaymentStatusRequest refreshPaymentStatusRequest, ApiCallback<PtsV2PaymentsPost201Response1> callback) Check a Payment Status (asynchronously) Checks and updates the payment status
okhttp3.Call	refreshPaymentStatusCall(String id, RefreshPaymentStatusRequest refreshPaymentStatusRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for refreshPaymentStatus
ApiResponse<PtsV2PaymentsPost201Response1>	refreshPaymentStatusWithHttpInfo(String id, RefreshPaymentStatusRequest refreshPaymentStatusRequest) Check a Payment Status Checks and updates the payment status
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentsApi

public PaymentsApi()

PaymentsApi

public PaymentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPaymentCall

public okhttp3.Call createPaymentCall(CreatePaymentRequest createPaymentRequest,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException

Build call for createPayment

Parameters:

createPaymentRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createPayment

public PtsV2PaymentsPost201Response createPayment(CreatePaymentRequest createPaymentRequest)
                                           throws ApiException

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

createPaymentRequest - (required)

Returns:

PtsV2PaymentsPost201Response

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPaymentWithHttpInfo

public ApiResponse<PtsV2PaymentsPost201Response> createPaymentWithHttpInfo(CreatePaymentRequest createPaymentRequest)
                                                                    throws ApiException

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

createPaymentRequest - (required)

Returns:

ApiResponse<PtsV2PaymentsPost201Response>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPaymentAsync

public okhttp3.Call createPaymentAsync(CreatePaymentRequest createPaymentRequest,
                                       ApiCallback<PtsV2PaymentsPost201Response> callback)
                                throws ApiException

Process a Payment (asynchronously) A payment authorizes the amount for the transaction. There are a number of supported payment feature, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

createPaymentRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

incrementAuthCall

public okhttp3.Call incrementAuthCall(String id,
                                      IncrementAuthRequest incrementAuthRequest,
                                      ProgressResponseBody.ProgressListener progressListener,
                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                               throws ApiException

Build call for incrementAuth

Parameters:

id - The ID returned from the original authorization request. (required)

incrementAuthRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

incrementAuth

public PtsV2IncrementalAuthorizationPatch201Response incrementAuth(String id,
                                                                   IncrementAuthRequest incrementAuthRequest)
                                                            throws ApiException

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

id - The ID returned from the original authorization request. (required)

incrementAuthRequest - (required)

Returns:

PtsV2IncrementalAuthorizationPatch201Response

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

incrementAuthWithHttpInfo

public ApiResponse<PtsV2IncrementalAuthorizationPatch201Response> incrementAuthWithHttpInfo(String id,
                                                                                            IncrementAuthRequest incrementAuthRequest)
                                                                                     throws ApiException

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

id - The ID returned from the original authorization request. (required)

incrementAuthRequest - (required)

Returns:

ApiResponse<PtsV2IncrementalAuthorizationPatch201Response>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

incrementAuthAsync

public okhttp3.Call incrementAuthAsync(String id,
                                       IncrementAuthRequest incrementAuthRequest,
                                       ApiCallback<PtsV2IncrementalAuthorizationPatch201Response> callback)
                                throws ApiException

Increment an Authorization (asynchronously) Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

id - The ID returned from the original authorization request. (required)

incrementAuthRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

refreshPaymentStatusCall

public okhttp3.Call refreshPaymentStatusCall(String id,
                                             RefreshPaymentStatusRequest refreshPaymentStatusRequest,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for refreshPaymentStatus

Parameters:

id - The payment id whose status needs to be checked and updated. (required)

refreshPaymentStatusRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

refreshPaymentStatus

public PtsV2PaymentsPost201Response1 refreshPaymentStatus(String id,
                                                          RefreshPaymentStatusRequest refreshPaymentStatusRequest)
                                                   throws ApiException

Check a Payment Status Checks and updates the payment status

Parameters:

id - The payment id whose status needs to be checked and updated. (required)

refreshPaymentStatusRequest - (required)

Returns:

PtsV2PaymentsPost201Response1

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

refreshPaymentStatusWithHttpInfo

public ApiResponse<PtsV2PaymentsPost201Response1> refreshPaymentStatusWithHttpInfo(String id,
                                                                                   RefreshPaymentStatusRequest refreshPaymentStatusRequest)
                                                                            throws ApiException

Check a Payment Status Checks and updates the payment status

Parameters:

id - The payment id whose status needs to be checked and updated. (required)

refreshPaymentStatusRequest - (required)

Returns:

ApiResponse<PtsV2PaymentsPost201Response1>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

refreshPaymentStatusAsync

public okhttp3.Call refreshPaymentStatusAsync(String id,
                                              RefreshPaymentStatusRequest refreshPaymentStatusRequest,
                                              ApiCallback<PtsV2PaymentsPost201Response1> callback)
                                       throws ApiException

Check a Payment Status (asynchronously) Checks and updates the payment status

Parameters:

id - The payment id whose status needs to be checked and updated. (required)

refreshPaymentStatusRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object