Class FundingAccountApi
- java.lang.Object
-
- com.orbipay.paymentsapi.internal.api.FundingAccountApi
-
public class FundingAccountApi extends java.lang.Object
This class subject to change without prior notice, Please dont use this class directly.
-
-
Constructor Summary
Constructors Constructor Description FundingAccountApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiResponse<FundingAccountResponse>
addFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Add Funding Account This API is used to add a funding account for the customer.com.squareup.okhttp.Call
addFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback)
Add Funding Account (asynchronously) This API is used to add a funding account for the customer.com.squareup.okhttp.Call
addFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for addFundingAccountApiResponse<FundingAccountResponse>
addFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Add Funding Account This API is used to add a funding account for the customer.ApiResponse<DeleteResponse>
deleteFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer.com.squareup.okhttp.Call
deleteFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<DeleteResponse> callback)
Delete Funding Account (asynchronously) The Delete Funding Account API is used to delete the funding account of a customer.com.squareup.okhttp.Call
deleteFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteFundingAccountApiResponse<DeleteResponse>
deleteFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer.ApiClient
getApiClient()
ApiResponse<FundingAccountResponse>
getFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.com.squareup.okhttp.Call
getFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback)
Get Funding Account (asynchronously) The Get Funding Account API is used to retrieve the details of the funding account based on the id.com.squareup.okhttp.Call
getFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getFundingAccountApiResponse<FundingAccountResponse>
getFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.ApiResponse<FundingAccountResponse>
replaceFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Replace Funding Account The API is used to replace the funding account details.com.squareup.okhttp.Call
replaceFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback)
Replace Funding Account (asynchronously) The API is used to replace the funding account details.com.squareup.okhttp.Call
replaceFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for replaceFundingAccountApiResponse<FundingAccountResponse>
replaceFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Replace Funding Account The API is used to replace the funding account details.ApiResponse<FundingAccountsResponse>
retrieveFundingAccounts(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype)
Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer.com.squareup.okhttp.Call
retrieveFundingAccountsAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype, ApiCallback<FundingAccountsResponse> callback)
Retrieve Funding Accounts (asynchronously) This API is used to retrieve all the funding accounts associated with a customer.com.squareup.okhttp.Call
retrieveFundingAccountsCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for retrieveFundingAccountsApiResponse<FundingAccountsResponse>
retrieveFundingAccountsPage(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex)
Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.com.squareup.okhttp.Call
retrieveFundingAccountsPageAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<FundingAccountsResponse> callback)
Retrieve Funding Accounts Pagination (asynchronously) This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.com.squareup.okhttp.Call
retrieveFundingAccountsPageCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for retrieveFundingAccountsPageApiResponse<FundingAccountsResponse>
retrieveFundingAccountsPageWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex)
Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.ApiResponse<FundingAccountsResponse>
retrieveFundingAccountsWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype)
Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer.void
setApiClient(ApiClient apiClient)
ApiResponse<FundingAccountResponse>
updateFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Update Funding Account The API is used to edit the funding account details.com.squareup.okhttp.Call
updateFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback)
Update Funding Account (asynchronously) The API is used to edit the funding account details.com.squareup.okhttp.Call
updateFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateFundingAccountApiResponse<FundingAccountResponse>
updateFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
Update Funding Account The API is used to edit the funding account details.
-
-
-
Constructor Detail
-
FundingAccountApi
public FundingAccountApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
addFundingAccountCall
public com.squareup.okhttp.Call addFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for addFundingAccount- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)addFundingAccountRequest
- JSON containing all the attributes of the Funding account to be added to customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
addFundingAccount
public ApiResponse<FundingAccountResponse> addFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Add Funding Account This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)addFundingAccountRequest
- JSON containing all the attributes of the Funding account to be added to customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- FundingAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addFundingAccountWithHttpInfo
public ApiResponse<FundingAccountResponse> addFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Add Funding Account This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)addFundingAccountRequest
- JSON containing all the attributes of the Funding account to be added to customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- ApiResponse<FundingAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addFundingAccountAsync
public com.squareup.okhttp.Call addFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, AddFundingAccountRequest addFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback) throws ApiException
Add Funding Account (asynchronously) This API is used to add a funding account for the customer. The funding account is available for servicing all the customer accounts the customer holds. An exhaustive set of account types are supported as funding accounts as indicated in the field account_subtype. ABA routing number and account sub-type are mandatory for bank accounts. Expiry date, address fields and Card CVV are required for card accounts.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)addFundingAccountRequest
- JSON containing all the attributes of the Funding account to be added to customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (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
-
deleteFundingAccountCall
public com.squareup.okhttp.Call deleteFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for deleteFundingAccount- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)deleteFundingAccountRequest
- Details of account to be deleted. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
deleteFundingAccount
public ApiResponse<DeleteResponse> deleteFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)deleteFundingAccountRequest
- Details of account to be deleted. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- DeleteResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteFundingAccountWithHttpInfo
public ApiResponse<DeleteResponse> deleteFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Delete Funding Account The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)deleteFundingAccountRequest
- Details of account to be deleted. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- ApiResponse<DeleteResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteFundingAccountAsync
public com.squareup.okhttp.Call deleteFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, DeleteFundingAccountRequest deleteFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<DeleteResponse> callback) throws ApiException
Delete Funding Account (asynchronously) The Delete Funding Account API is used to delete the funding account of a customer. All pending payments made with that account are cancelled upon deletion of the funding account.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)deleteFundingAccountRequest
- Details of account to be deleted. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (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
-
getFundingAccountCall
public com.squareup.okhttp.Call getFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for getFundingAccount- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
getFundingAccount
public ApiResponse<FundingAccountResponse> getFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- FundingAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFundingAccountWithHttpInfo
public ApiResponse<FundingAccountResponse> getFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Get Funding Account The Get Funding Account API is used to retrieve the details of the funding account based on the id.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- ApiResponse<FundingAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFundingAccountAsync
public com.squareup.okhttp.Call getFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback) throws ApiException
Get Funding Account (asynchronously) The Get Funding Account API is used to retrieve the details of the funding account based on the id.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (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
-
replaceFundingAccountCall
public com.squareup.okhttp.Call replaceFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for replaceFundingAccount- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)replaceFundingAccountRequest
- JSON containing all the attributes of the Funding account to be replaced. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
replaceFundingAccount
public ApiResponse<FundingAccountResponse> replaceFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Replace Funding Account The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)replaceFundingAccountRequest
- JSON containing all the attributes of the Funding account to be replaced. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- FundingAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
replaceFundingAccountWithHttpInfo
public ApiResponse<FundingAccountResponse> replaceFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Replace Funding Account The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)replaceFundingAccountRequest
- JSON containing all the attributes of the Funding account to be replaced. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- ApiResponse<FundingAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
replaceFundingAccountAsync
public com.squareup.okhttp.Call replaceFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, ReplaceFundingAccountRequest replaceFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback) throws ApiException
Replace Funding Account (asynchronously) The API is used to replace the funding account details. The type of the funding account cannot be replaced. In other words, a card account cannot be replaced to a bank account and vice versa. CVV is mandatory to make any change to a card account.Replacing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)replaceFundingAccountRequest
- JSON containing all the attributes of the Funding account to be replaced. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (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
-
retrieveFundingAccountsCall
public com.squareup.okhttp.Call retrieveFundingAccountsCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for retrieveFundingAccounts- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)accountNumber
- The Account Number to get details of. (optional)status
- The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)abaRoutingNumber
- The ABA/Routing number for the bank account. (optional)accountType
- The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)accountSubtype
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
retrieveFundingAccounts
public ApiResponse<FundingAccountsResponse> retrieveFundingAccounts(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype) throws ApiException
Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)accountNumber
- The Account Number to get details of. (optional)status
- The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)abaRoutingNumber
- The ABA/Routing number for the bank account. (optional)accountType
- The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)accountSubtype
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)- Returns:
- FundingAccountsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
retrieveFundingAccountsWithHttpInfo
public ApiResponse<FundingAccountsResponse> retrieveFundingAccountsWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype) throws ApiException
Retrieve Funding Accounts This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)accountNumber
- The Account Number to get details of. (optional)status
- The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)abaRoutingNumber
- The ABA/Routing number for the bank account. (optional)accountType
- The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)accountSubtype
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (optional)- Returns:
- ApiResponse<FundingAccountsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
retrieveFundingAccountsAsync
public com.squareup.okhttp.Call retrieveFundingAccountsAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String accountNumber, java.util.List<java.lang.String> status, java.lang.String abaRoutingNumber, java.util.List<java.lang.String> accountType, java.lang.String accountSubtype, ApiCallback<FundingAccountsResponse> callback) throws ApiException
Retrieve Funding Accounts (asynchronously) This API is used to retrieve all the funding accounts associated with a customer. Accounts can be filtered using the account number, the ABA routing number (for bank accounts), the account status, account type, account sub-type and others mentioned below. The results are sorted based on their last_modified_time in descending order. The API responds with the first page of the list of funding accounts matching the criteria.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)accountNumber
- The Account Number to get details of. (optional)status
- The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2.... (optional)abaRoutingNumber
- The ABA/Routing number for the bank account. (optional)accountType
- The type of the funding account. This can take multiple values in the format key=value1&key=value2.... (optional)accountSubtype
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. (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
-
retrieveFundingAccountsPageCall
public com.squareup.okhttp.Call retrieveFundingAccountsPageCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for retrieveFundingAccountsPage- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)queryId
- query id of the Retrieve/Search Accounts lookup. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)fromIndex
- To fetch the next set of objects that start after this object (optional)toIndex
- To fetch the previous set of objects that end at this object (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
retrieveFundingAccountsPage
public ApiResponse<FundingAccountsResponse> retrieveFundingAccountsPage(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex) throws ApiException
Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)queryId
- query id of the Retrieve/Search Accounts lookup. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)fromIndex
- To fetch the next set of objects that start after this object (optional)toIndex
- To fetch the previous set of objects that end at this object (optional)- Returns:
- FundingAccountsResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
retrieveFundingAccountsPageWithHttpInfo
public ApiResponse<FundingAccountsResponse> retrieveFundingAccountsPageWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex) throws ApiException
Retrieve Funding Accounts Pagination This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)queryId
- query id of the Retrieve/Search Accounts lookup. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)fromIndex
- To fetch the next set of objects that start after this object (optional)toIndex
- To fetch the previous set of objects that end at this object (optional)- Returns:
- ApiResponse<FundingAccountsResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
retrieveFundingAccountsPageAsync
public com.squareup.okhttp.Call retrieveFundingAccountsPageAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, java.lang.String queryId, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String pageSize, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<FundingAccountsResponse> callback) throws ApiException
Retrieve Funding Accounts Pagination (asynchronously) This API is used to paginate through the list of funding accounts returned in the Retrieve Funding Accounts API.- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)queryId
- query id of the Retrieve/Search Accounts lookup. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)pageSize
- The maximum number of objects returned in the query. (optional)fromIndex
- To fetch the next set of objects that start after this object (optional)toIndex
- To fetch the previous set of objects that end at this object (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
-
updateFundingAccountCall
public com.squareup.okhttp.Call updateFundingAccountCall(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
Build call for updateFundingAccount- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)updateFundingAccountRequest
- JSON containing all the attributes of the Funding account to be updated. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)progressListener
- Progress listenerprogressRequestListener
- Progress request listener- Returns:
- Call to execute
- Throws:
ApiException
- If fail to serialize the request body object
-
updateFundingAccount
public ApiResponse<FundingAccountResponse> updateFundingAccount(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Update Funding Account The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)updateFundingAccountRequest
- JSON containing all the attributes of the Funding account to be updated. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- FundingAccountResponse
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateFundingAccountWithHttpInfo
public ApiResponse<FundingAccountResponse> updateFundingAccountWithHttpInfo(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId) throws ApiException
Update Funding Account The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)updateFundingAccountRequest
- JSON containing all the attributes of the Funding account to be updated. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (optional)- Returns:
- ApiResponse<FundingAccountResponse>
- Throws:
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateFundingAccountAsync
public com.squareup.okhttp.Call updateFundingAccountAsync(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_FUNDING_ACCOUNT, java.lang.String ID_CUSTOMER, UpdateFundingAccountRequest updateFundingAccountRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<FundingAccountResponse> callback) throws ApiException
Update Funding Account (asynchronously) The API is used to edit the funding account details. The type of the funding account cannot be changed. In other words, a card account cannot be changed to a bank account and vice versa. The sub-type of a bank account can be changed. For e.g., a saving account can be updated to a money market account. However, the sub-type cannot be updated for a card account. CVV is mandatory to make any change to a card account. The Id of the funding account gets updated to a new value if the account number is updated. Editing a funding account updates the account information on all pending payments made using that account but does not change the details on payments that have been completed. <br><br> Below are the possible funding account state transformation. | from_status | to_status | allowed requestor_type | | ------------ | ------------ | ------------ | | active | deleted| <ul> <li>external_user</li> <li> client_agent</li> <li> system</li> <li> customer</li></ul> | | active | frozen | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | inactive | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> | | active | unverified | <ul> <li>system</li></ul> | | frozen | active | <ul> <li>external_user </li> <li> client_agent</li></ul> | | inactive | active | <ul> <li>external_user </li> <li> client_agent </li> <li> system</li></ul> |- Parameters:
channel
- The channel through which the API is invoked. (required)clientKey
- The unique identifier assigned by EBPP to the client. (required)product
- The product identifier corresponding to the API. (required)timestamp
- The timestamp for the moment when the API request is created. (required)idempotentRequestKey
- The unique token that clients can generate and maintain in order to identify an API request. (required)requestorType
- Type of the requestor of the API. (required)ID_FUNDING_ACCOUNT
- The unique identifier assigned by EBPP to the Funding Account. (required)ID_CUSTOMER
- The unique identifier assigned by EBPP to the customer. (required)updateFundingAccountRequest
- JSON containing all the attributes of the Funding account to be updated. (required)requestor
- The identifier for the requestor of the API. (optional)xOPAYHeaders
- Intended for the future use. (optional)traceId
- The unique reference that can be used for tracing and debugging an API call. (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
-
-