Api

Class PaymentLinksApi

java.lang.Object

Api.PaymentLinksApi

public class PaymentLinksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentLinksApi()
PaymentLinksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PblPaymentLinksPost201Response	createPaymentLink(CreatePaymentLinkRequest createPaymentLinkRequest) Create a Payment Link Create a new payment link.
okhttp3.Call	createPaymentLinkAsync(CreatePaymentLinkRequest createPaymentLinkRequest, ApiCallback<PblPaymentLinksPost201Response> callback) Create a Payment Link (asynchronously) Create a new payment link.
okhttp3.Call	createPaymentLinkCall(CreatePaymentLinkRequest createPaymentLinkRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createPaymentLink
ApiResponse<PblPaymentLinksPost201Response>	createPaymentLinkWithHttpInfo(CreatePaymentLinkRequest createPaymentLinkRequest) Create a Payment Link Create a new payment link.
PblPaymentLinksAllGet200Response	getAllPaymentLinks(Integer offset, Integer limit, String status) Get a List of Payment Links Provides a (filtered) list of payment links that have been created in your account.
okhttp3.Call	getAllPaymentLinksAsync(Integer offset, Integer limit, String status, ApiCallback<PblPaymentLinksAllGet200Response> callback) Get a List of Payment Links (asynchronously) Provides a (filtered) list of payment links that have been created in your account.
okhttp3.Call	getAllPaymentLinksCall(Integer offset, Integer limit, String status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllPaymentLinks
ApiResponse<PblPaymentLinksAllGet200Response>	getAllPaymentLinksWithHttpInfo(Integer offset, Integer limit, String status) Get a List of Payment Links Provides a (filtered) list of payment links that have been created in your account.
ApiClient	getApiClient()
PblPaymentLinksGet200Response	getPaymentLink(String id) Get Payment Link Details You can retrieve details of a specific payment link.
okhttp3.Call	getPaymentLinkAsync(String id, ApiCallback<PblPaymentLinksGet200Response> callback) Get Payment Link Details (asynchronously) You can retrieve details of a specific payment link.
okhttp3.Call	getPaymentLinkCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPaymentLink
ApiResponse<PblPaymentLinksGet200Response>	getPaymentLinkWithHttpInfo(String id) Get Payment Link Details You can retrieve details of a specific payment link.
void	setApiClient(ApiClient apiClient)
PblPaymentLinksPost201Response	updatePaymentLink(String id, UpdatePaymentLinkRequest updatePaymentLinkRequest) Update a Payment Link You can update all information except the payment link number until any payment is received for a payment link.
okhttp3.Call	updatePaymentLinkAsync(String id, UpdatePaymentLinkRequest updatePaymentLinkRequest, ApiCallback<PblPaymentLinksPost201Response> callback) Update a Payment Link (asynchronously) You can update all information except the payment link number until any payment is received for a payment link.
okhttp3.Call	updatePaymentLinkCall(String id, UpdatePaymentLinkRequest updatePaymentLinkRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updatePaymentLink
ApiResponse<PblPaymentLinksPost201Response>	updatePaymentLinkWithHttpInfo(String id, UpdatePaymentLinkRequest updatePaymentLinkRequest) Update a Payment Link You can update all information except the payment link number until any payment is received for a payment link.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentLinksApi

public PaymentLinksApi()

PaymentLinksApi

public PaymentLinksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPaymentLinkCall

public okhttp3.Call createPaymentLinkCall(CreatePaymentLinkRequest createPaymentLinkRequest,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException

Build call for createPaymentLink

Parameters:

createPaymentLinkRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createPaymentLink

public PblPaymentLinksPost201Response createPaymentLink(CreatePaymentLinkRequest createPaymentLinkRequest)
                                                 throws ApiException

Create a Payment Link Create a new payment link.

Parameters:

createPaymentLinkRequest - (required)

Returns:

PblPaymentLinksPost201Response

Throws:

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

createPaymentLinkWithHttpInfo

public ApiResponse<PblPaymentLinksPost201Response> createPaymentLinkWithHttpInfo(CreatePaymentLinkRequest createPaymentLinkRequest)
                                                                          throws ApiException

Create a Payment Link Create a new payment link.

Parameters:

createPaymentLinkRequest - (required)

Returns:

ApiResponse<PblPaymentLinksPost201Response>

Throws:

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

createPaymentLinkAsync

public okhttp3.Call createPaymentLinkAsync(CreatePaymentLinkRequest createPaymentLinkRequest,
                                           ApiCallback<PblPaymentLinksPost201Response> callback)
                                    throws ApiException

Create a Payment Link (asynchronously) Create a new payment link.

Parameters:

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

getAllPaymentLinksCall

public okhttp3.Call getAllPaymentLinksCall(Integer offset,
                                           Integer limit,
                                           String status,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for getAllPaymentLinks

Parameters:

offset - Page offset number. (required)

limit - Maximum number of items you would like returned. Maximum limit: 1000 (required)

status - The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllPaymentLinks

public PblPaymentLinksAllGet200Response getAllPaymentLinks(Integer offset,
                                                           Integer limit,
                                                           String status)
                                                    throws ApiException

Get a List of Payment Links Provides a (filtered) list of payment links that have been created in your account. You can filter the list based on the following status types: - ACTIVE - INACTIVE

Parameters:

offset - Page offset number. (required)

limit - Maximum number of items you would like returned. Maximum limit: 1000 (required)

status - The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE (optional)

Returns:

PblPaymentLinksAllGet200Response

Throws:

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

getAllPaymentLinksWithHttpInfo

public ApiResponse<PblPaymentLinksAllGet200Response> getAllPaymentLinksWithHttpInfo(Integer offset,
                                                                                    Integer limit,
                                                                                    String status)
                                                                             throws ApiException

Get a List of Payment Links Provides a (filtered) list of payment links that have been created in your account. You can filter the list based on the following status types: - ACTIVE - INACTIVE

Parameters:

offset - Page offset number. (required)

limit - Maximum number of items you would like returned. Maximum limit: 1000 (required)

status - The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE (optional)

Returns:

ApiResponse<PblPaymentLinksAllGet200Response>

Throws:

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

getAllPaymentLinksAsync

public okhttp3.Call getAllPaymentLinksAsync(Integer offset,
                                            Integer limit,
                                            String status,
                                            ApiCallback<PblPaymentLinksAllGet200Response> callback)
                                     throws ApiException

Get a List of Payment Links (asynchronously) Provides a (filtered) list of payment links that have been created in your account. You can filter the list based on the following status types: - ACTIVE - INACTIVE

Parameters:

offset - Page offset number. (required)

limit - Maximum number of items you would like returned. Maximum limit: 1000 (required)

status - The status of the purchase or donation link. Possible values: - ACTIVE - INACTIVE (optional)

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

getPaymentLinkCall

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

Build call for getPaymentLink

Parameters:

id - The purchase number. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPaymentLink

public PblPaymentLinksGet200Response getPaymentLink(String id)
                                             throws ApiException

Get Payment Link Details You can retrieve details of a specific payment link. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.

Parameters:

id - The purchase number. (required)

Returns:

PblPaymentLinksGet200Response

Throws:

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

getPaymentLinkWithHttpInfo

public ApiResponse<PblPaymentLinksGet200Response> getPaymentLinkWithHttpInfo(String id)
                                                                      throws ApiException

Get Payment Link Details You can retrieve details of a specific payment link. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.

Parameters:

id - The purchase number. (required)

Returns:

ApiResponse<PblPaymentLinksGet200Response>

Throws:

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

getPaymentLinkAsync

public okhttp3.Call getPaymentLinkAsync(String id,
                                        ApiCallback<PblPaymentLinksGet200Response> callback)
                                 throws ApiException

Get Payment Link Details (asynchronously) You can retrieve details of a specific payment link. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.

Parameters:

id - The purchase number. (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

updatePaymentLinkCall

public okhttp3.Call updatePaymentLinkCall(String id,
                                          UpdatePaymentLinkRequest updatePaymentLinkRequest,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws ApiException

Build call for updatePaymentLink

Parameters:

id - The purchase number. (required)

updatePaymentLinkRequest - Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updatePaymentLink

public PblPaymentLinksPost201Response updatePaymentLink(String id,
                                                        UpdatePaymentLinkRequest updatePaymentLinkRequest)
                                                 throws ApiException

Update a Payment Link You can update all information except the payment link number until any payment is received for a payment link.

Parameters:

id - The purchase number. (required)

updatePaymentLinkRequest - Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately. (required)

Returns:

PblPaymentLinksPost201Response

Throws:

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

updatePaymentLinkWithHttpInfo

public ApiResponse<PblPaymentLinksPost201Response> updatePaymentLinkWithHttpInfo(String id,
                                                                                 UpdatePaymentLinkRequest updatePaymentLinkRequest)
                                                                          throws ApiException

Update a Payment Link You can update all information except the payment link number until any payment is received for a payment link.

Parameters:

id - The purchase number. (required)

updatePaymentLinkRequest - Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately. (required)

Returns:

ApiResponse<PblPaymentLinksPost201Response>

Throws:

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

updatePaymentLinkAsync

public okhttp3.Call updatePaymentLinkAsync(String id,
                                           UpdatePaymentLinkRequest updatePaymentLinkRequest,
                                           ApiCallback<PblPaymentLinksPost201Response> callback)
                                    throws ApiException

Update a Payment Link (asynchronously) You can update all information except the payment link number until any payment is received for a payment link.

Parameters:

id - The purchase number. (required)

updatePaymentLinkRequest - Updating the purchase or donation link does not resend the link automatically. You must resend the purchase or donation link separately. (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