Package api

Class MerchantProfilesApi

java.lang.Object

api.MerchantProfilesApi

public class MerchantProfilesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MerchantProfilesApi.APIlistMerchantProfilesRequest

Constructor Summary

Constructors

Constructor	Description
MerchantProfilesApi()
MerchantProfilesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
MerchantProfile	get(String merchantProfileId)	Fetch a Merchant Profile Retrieve the details of a previosuly created `merchant_profile`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getMerchantProfileAsync(String merchantProfileId, ApiCallback<MerchantProfile> _callback)	Fetch a Merchant Profile (asynchronously) Retrieve the details of a previosuly created `merchant_profile`.
okhttp3.Call	getMerchantProfileCall(String merchantProfileId, ApiCallback _callback)	Build call for getMerchantProfile
ApiResponse<MerchantProfile>	getMerchantProfileWithHttpInfo(String merchantProfileId)	Fetch a Merchant Profile Retrieve the details of a previosuly created `merchant_profile`.
FinixList	list(ListMerchantProfilesQueryParams listMerchantProfilesQueryParams)	List Merchant Profiles Retireve a list of all `merchant_profiles`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
MerchantProfile	update(String merchantProfileId, UpdateMerchantProfileRequest updateMerchantProfileRequest)	Update a Merchant Profile Update a `merchant_profile`.
okhttp3.Call	updateMerchantProfileAsync(String merchantProfileId, UpdateMerchantProfileRequest updateMerchantProfileRequest, ApiCallback<MerchantProfile> _callback)	Update a Merchant Profile (asynchronously) Update a `merchant_profile`.
okhttp3.Call	updateMerchantProfileCall(String merchantProfileId, UpdateMerchantProfileRequest updateMerchantProfileRequest, ApiCallback _callback)	Build call for updateMerchantProfile
ApiResponse<MerchantProfile>	updateMerchantProfileWithHttpInfo(String merchantProfileId, UpdateMerchantProfileRequest updateMerchantProfileRequest)	Update a Merchant Profile Update a `merchant_profile`.

Methods inherited from class java.lang.Object

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

Constructor Detail

MerchantProfilesApi

public MerchantProfilesApi()

MerchantProfilesApi

public MerchantProfilesApi(FinixClient finixClient)

Method Detail

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getMerchantProfileCall

public okhttp3.Call getMerchantProfileCall(String merchantProfileId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getMerchantProfile

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public MerchantProfile get(String merchantProfileId)
                    throws ApiException

Fetch a Merchant Profile Retrieve the details of a previosuly created `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

Returns:

MerchantProfile

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getMerchantProfileWithHttpInfo

public ApiResponse<MerchantProfile> getMerchantProfileWithHttpInfo(String merchantProfileId)
                                                            throws ApiException

Fetch a Merchant Profile Retrieve the details of a previosuly created `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

Returns:

ApiResponse<MerchantProfile>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getMerchantProfileAsync

public okhttp3.Call getMerchantProfileAsync(String merchantProfileId,
                                            ApiCallback<MerchantProfile> _callback)
                                     throws ApiException

Fetch a Merchant Profile (asynchronously) Retrieve the details of a previosuly created `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListMerchantProfilesQueryParams listMerchantProfilesQueryParams)
               throws ApiException

List Merchant Profiles Retireve a list of all `merchant_profiles`.

Returns:

APIlistMerchantProfilesRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateMerchantProfileCall

public okhttp3.Call updateMerchantProfileCall(String merchantProfileId,
                                              UpdateMerchantProfileRequest updateMerchantProfileRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for updateMerchantProfile

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

updateMerchantProfileRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

update

public MerchantProfile update(String merchantProfileId,
                              UpdateMerchantProfileRequest updateMerchantProfileRequest)
                       throws ApiException

Update a Merchant Profile Update a `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

updateMerchantProfileRequest - (optional)

Returns:

MerchantProfile

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateMerchantProfileWithHttpInfo

public ApiResponse<MerchantProfile> updateMerchantProfileWithHttpInfo(String merchantProfileId,
                                                                      UpdateMerchantProfileRequest updateMerchantProfileRequest)
                                                               throws ApiException

Update a Merchant Profile Update a `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

updateMerchantProfileRequest - (optional)

Returns:

ApiResponse<MerchantProfile>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateMerchantProfileAsync

public okhttp3.Call updateMerchantProfileAsync(String merchantProfileId,
                                               UpdateMerchantProfileRequest updateMerchantProfileRequest,
                                               ApiCallback<MerchantProfile> _callback)
                                        throws ApiException

Update a Merchant Profile (asynchronously) Update a `merchant_profile`.

Parameters:

merchantProfileId - ID of `merchant_profile`. (required)

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

Http Response Details:

Status Code	Description	Response Headers
200	Single merchant profile object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -