Api

Class BillingAgreementsApi

java.lang.Object

Api.BillingAgreementsApi

public class BillingAgreementsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
BillingAgreementsApi()
BillingAgreementsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PtsV2ModifyBillingAgreementPost201Response	billingAgreementsDeRegistration(ModifyBillingAgreement modifyBillingAgreement, String id)	Modify a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsDeRegistrationAsync(ModifyBillingAgreement modifyBillingAgreement, String id, ApiCallback<PtsV2ModifyBillingAgreementPost201Response> callback)	Modify a Billing Agreement (asynchronously) #### Standing Instruction: Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsDeRegistrationCall(ModifyBillingAgreement modifyBillingAgreement, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for billingAgreementsDeRegistration
ApiResponse<PtsV2ModifyBillingAgreementPost201Response>	billingAgreementsDeRegistrationWithHttpInfo(ModifyBillingAgreement modifyBillingAgreement, String id)	Modify a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token.
PtsV2CreditsPost201Response1	billingAgreementsIntimation(IntimateBillingAgreement intimateBillingAgreement, String id)	Standing Instruction intimation Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsIntimationAsync(IntimateBillingAgreement intimateBillingAgreement, String id, ApiCallback<PtsV2CreditsPost201Response1> callback)	Standing Instruction intimation (asynchronously) Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsIntimationCall(IntimateBillingAgreement intimateBillingAgreement, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for billingAgreementsIntimation
ApiResponse<PtsV2CreditsPost201Response1>	billingAgreementsIntimationWithHttpInfo(IntimateBillingAgreement intimateBillingAgreement, String id)	Standing Instruction intimation Standing Instruction with or without Token.
PtsV2CreateBillingAgreementPost201Response	billingAgreementsRegistration(CreateBillingAgreement createBillingAgreement)	Create a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsRegistrationAsync(CreateBillingAgreement createBillingAgreement, ApiCallback<PtsV2CreateBillingAgreementPost201Response> callback)	Create a Billing Agreement (asynchronously) #### Standing Instruction: Standing Instruction with or without Token.
okhttp3.Call	billingAgreementsRegistrationCall(CreateBillingAgreement createBillingAgreement, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for billingAgreementsRegistration
ApiResponse<PtsV2CreateBillingAgreementPost201Response>	billingAgreementsRegistrationWithHttpInfo(CreateBillingAgreement createBillingAgreement)	Create a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BillingAgreementsApi

public BillingAgreementsApi()

BillingAgreementsApi

public BillingAgreementsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

billingAgreementsDeRegistrationCall

public okhttp3.Call billingAgreementsDeRegistrationCall(ModifyBillingAgreement modifyBillingAgreement,
                                                        String id,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException,
                                                        com.cybersource.authsdk.core.ConfigException

Build call for billingAgreementsDeRegistration

Parameters:

modifyBillingAgreement - (required)

id - ID for de-registration or cancellation of Billing Agreement (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsDeRegistration

public PtsV2ModifyBillingAgreementPost201Response billingAgreementsDeRegistration(ModifyBillingAgreement modifyBillingAgreement,
                                                                                  String id)
                                                                           throws ApiException,
                                                                                  com.cybersource.authsdk.core.ConfigException

Modify a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.

Parameters:

modifyBillingAgreement - (required)

id - ID for de-registration or cancellation of Billing Agreement (required)

Returns:

PtsV2ModifyBillingAgreementPost201Response

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsDeRegistrationWithHttpInfo

public ApiResponse<PtsV2ModifyBillingAgreementPost201Response> billingAgreementsDeRegistrationWithHttpInfo(ModifyBillingAgreement modifyBillingAgreement,
                                                                                                           String id)
                                                                                                    throws ApiException,
                                                                                                           com.cybersource.authsdk.core.ConfigException

Modify a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.

Parameters:

modifyBillingAgreement - (required)

id - ID for de-registration or cancellation of Billing Agreement (required)

Returns:

ApiResponse<PtsV2ModifyBillingAgreementPost201Response>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsDeRegistrationAsync

public okhttp3.Call billingAgreementsDeRegistrationAsync(ModifyBillingAgreement modifyBillingAgreement,
                                                         String id,
                                                         ApiCallback<PtsV2ModifyBillingAgreementPost201Response> callback)
                                                  throws ApiException,
                                                         com.cybersource.authsdk.core.ConfigException

Modify a Billing Agreement (asynchronously) #### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.

Parameters:

modifyBillingAgreement - (required)

id - ID for de-registration or cancellation of Billing Agreement (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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsIntimationCall

public okhttp3.Call billingAgreementsIntimationCall(IntimateBillingAgreement intimateBillingAgreement,
                                                    String id,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException,
                                                    com.cybersource.authsdk.core.ConfigException

Build call for billingAgreementsIntimation

Parameters:

intimateBillingAgreement - (required)

id - ID for intimation of Billing Agreement (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsIntimation

public PtsV2CreditsPost201Response1 billingAgreementsIntimation(IntimateBillingAgreement intimateBillingAgreement,
                                                                String id)
                                                         throws ApiException,
                                                                com.cybersource.authsdk.core.ConfigException

Standing Instruction intimation Standing Instruction with or without Token.

Parameters:

intimateBillingAgreement - (required)

id - ID for intimation of Billing Agreement (required)

Returns:

PtsV2CreditsPost201Response1

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsIntimationWithHttpInfo

public ApiResponse<PtsV2CreditsPost201Response1> billingAgreementsIntimationWithHttpInfo(IntimateBillingAgreement intimateBillingAgreement,
                                                                                         String id)
                                                                                  throws ApiException,
                                                                                         com.cybersource.authsdk.core.ConfigException

Standing Instruction intimation Standing Instruction with or without Token.

Parameters:

intimateBillingAgreement - (required)

id - ID for intimation of Billing Agreement (required)

Returns:

ApiResponse<PtsV2CreditsPost201Response1>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsIntimationAsync

public okhttp3.Call billingAgreementsIntimationAsync(IntimateBillingAgreement intimateBillingAgreement,
                                                     String id,
                                                     ApiCallback<PtsV2CreditsPost201Response1> callback)
                                              throws ApiException,
                                                     com.cybersource.authsdk.core.ConfigException

Standing Instruction intimation (asynchronously) Standing Instruction with or without Token.

Parameters:

intimateBillingAgreement - (required)

id - ID for intimation of Billing Agreement (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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsRegistrationCall

public okhttp3.Call billingAgreementsRegistrationCall(CreateBillingAgreement createBillingAgreement,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException,
                                                      com.cybersource.authsdk.core.ConfigException

Build call for billingAgreementsRegistration

Parameters:

createBillingAgreement - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsRegistration

public PtsV2CreateBillingAgreementPost201Response billingAgreementsRegistration(CreateBillingAgreement createBillingAgreement)
                                                                         throws ApiException,
                                                                                com.cybersource.authsdk.core.ConfigException

Create a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values: - Pending—the create mandate request was successfully processed. - Failed—the create mandate request was not accepted. #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when: - You have existing customers with signed, active mandates - You manage mandates outside of CyberSource. When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.

Parameters:

createBillingAgreement - (required)

Returns:

PtsV2CreateBillingAgreementPost201Response

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsRegistrationWithHttpInfo

public ApiResponse<PtsV2CreateBillingAgreementPost201Response> billingAgreementsRegistrationWithHttpInfo(CreateBillingAgreement createBillingAgreement)
                                                                                                  throws ApiException,
                                                                                                         com.cybersource.authsdk.core.ConfigException

Create a Billing Agreement #### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values: - Pending—the create mandate request was successfully processed. - Failed—the create mandate request was not accepted. #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when: - You have existing customers with signed, active mandates - You manage mandates outside of CyberSource. When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.

Parameters:

createBillingAgreement - (required)

Returns:

ApiResponse<PtsV2CreateBillingAgreementPost201Response>

Throws:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

billingAgreementsRegistrationAsync

public okhttp3.Call billingAgreementsRegistrationAsync(CreateBillingAgreement createBillingAgreement,
                                                       ApiCallback<PtsV2CreateBillingAgreementPost201Response> callback)
                                                throws ApiException,
                                                       com.cybersource.authsdk.core.ConfigException

Create a Billing Agreement (asynchronously) #### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values: - Pending—the create mandate request was successfully processed. - Failed—the create mandate request was not accepted. #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when: - You have existing customers with signed, active mandates - You manage mandates outside of CyberSource. When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.

Parameters:

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

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient