Api

Class PayoutsApi

java.lang.Object

Api.PayoutsApi

public class PayoutsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PayoutsApi()
PayoutsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
PtsV2PayoutsPost201Response	octCreatePayment(OctCreatePaymentRequest octCreatePaymentRequest) Process a Payout Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT).
okhttp3.Call	octCreatePaymentAsync(OctCreatePaymentRequest octCreatePaymentRequest, ApiCallback<PtsV2PayoutsPost201Response> callback) Process a Payout (asynchronously) Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT).
okhttp3.Call	octCreatePaymentCall(OctCreatePaymentRequest octCreatePaymentRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for octCreatePayment
ApiResponse<PtsV2PayoutsPost201Response>	octCreatePaymentWithHttpInfo(OctCreatePaymentRequest octCreatePaymentRequest) Process a Payout Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PayoutsApi

public PayoutsApi()

PayoutsApi

public PayoutsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

octCreatePaymentCall

public okhttp3.Call octCreatePaymentCall(OctCreatePaymentRequest octCreatePaymentRequest,
                                         ProgressResponseBody.ProgressListener progressListener,
                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                  throws ApiException

Build call for octCreatePayment

Parameters:

octCreatePaymentRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

octCreatePayment

public PtsV2PayoutsPost201Response octCreatePayment(OctCreatePaymentRequest octCreatePaymentRequest)
                                             throws ApiException

Process a Payout Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

octCreatePaymentRequest - (required)

Returns:

PtsV2PayoutsPost201Response

Throws:

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

octCreatePaymentWithHttpInfo

public ApiResponse<PtsV2PayoutsPost201Response> octCreatePaymentWithHttpInfo(OctCreatePaymentRequest octCreatePaymentRequest)
                                                                      throws ApiException

Process a Payout Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

octCreatePaymentRequest - (required)

Returns:

ApiResponse<PtsV2PayoutsPost201Response>

Throws:

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

octCreatePaymentAsync

public okhttp3.Call octCreatePaymentAsync(OctCreatePaymentRequest octCreatePaymentRequest,
                                          ApiCallback<PtsV2PayoutsPost201Response> callback)
                                   throws ApiException

Process a Payout (asynchronously) Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

octCreatePaymentRequest - (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