api.MerchantsApi

public class MerchantsApi extends Object

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

class

MerchantsApi.APIlistMerchantsRequest
Constructor Summary

Constructors

Constructor

Description

MerchantsApi()

MerchantsApi(FinixClient finixClient)
Method Summary

Modifier and Type

Method

Description

Merchant

create(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest)

Create a Merchant Create a `Merchant` to start the underwriting process for your merchant.

okhttp3.Call

createMerchantAsync(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest, ApiCallback<Merchant> _callback)

Create a Merchant (asynchronously) Create a `Merchant` to start the underwriting process for your merchant.

okhttp3.Call

createMerchantCall(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest, ApiCallback _callback)

Build call for createMerchant

Verification

createMerchantVerification(String merchantId, CreateVerificationRequest createVerificationRequest)

Verify a Merchant Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

okhttp3.Call

createMerchantVerificationAsync(String merchantId, CreateVerificationRequest createVerificationRequest, ApiCallback<Verification> _callback)

Verify a Merchant (asynchronously) Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

okhttp3.Call

createMerchantVerificationCall(String merchantId, CreateVerificationRequest createVerificationRequest, ApiCallback _callback)

Build call for createMerchantVerification

ApiResponse<Verification>

createMerchantVerificationWithHttpInfo(String merchantId, CreateVerificationRequest createVerificationRequest)

Verify a Merchant Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

ApiResponse<Merchant>

createMerchantWithHttpInfo(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest)

Create a Merchant Create a `Merchant` to start the underwriting process for your merchant.

Merchant

get(String merchantId)

Get a Merchant Retrieve the details of a `Merchant`.

String

getCustomBaseUrl()

FinixClient

getFinixClient()

int

getHostIndex()

okhttp3.Call

getMerchantAsync(String merchantId, ApiCallback<Merchant> _callback)

Get a Merchant (asynchronously) Retrieve the details of a `Merchant`.

okhttp3.Call

getMerchantCall(String merchantId, ApiCallback _callback)

Build call for getMerchant

ApiResponse<Merchant>

getMerchantWithHttpInfo(String merchantId)

Get a Merchant Retrieve the details of a `Merchant`.

MerchantsList

list(ListMerchantsQueryParams listMerchantsQueryParams)

List Merchants Retrieve a list of `Merchants`.

okhttp3.Call

putMerchantAsync(String merchantId, UpdateMerchantRequest updateMerchantRequest, ApiCallback<Merchant> _callback)

Update a Merchant (asynchronously) Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

okhttp3.Call

putMerchantCall(String merchantId, UpdateMerchantRequest updateMerchantRequest, ApiCallback _callback)

Build call for putMerchant

ApiResponse<Merchant>

putMerchantWithHttpInfo(String merchantId, UpdateMerchantRequest updateMerchantRequest)

Update a Merchant Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

void

setCustomBaseUrl(String customBaseUrl)

void

setFinixClient(FinixClient finixClient)

void

setHostIndex(int hostIndex)

Merchant

update(String merchantId, UpdateMerchantRequest updateMerchantRequest)

Update a Merchant Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MerchantsApi
  
  public MerchantsApi()
- MerchantsApi
  
  public MerchantsApi(FinixClient finixClient)

Method Details

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)

createMerchantCall

public okhttp3.Call createMerchantCall(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest, ApiCallback _callback) throws ApiException

Build call for createMerchant

Parameters:

identityId - ID of `Identity` to fetch. (required)

createMerchantUnderwritingRequest - (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
201	Single Merchant object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -
422	Error	* finix-apiuser-role - * date - * x-request-id -

create

public Merchant create(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest) throws ApiException

Create a Merchant Create a `Merchant` to start the underwriting process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities). > A bank account must be associated with the previously created `Identity` before a `Merchant` can be succefully onboarded and verified. `Merchant` resources can have three possible `onboarding_states`: 1. **PROVISIONING**: The request is pending (the state may change after two minutes). * `processing_enabled`: **False** * `settlement_enabled`: **False** 1. **APPROVED**: The `Merchant` has been approved and can begin processing payments. * `processing_enabled`: **True** * `settlement_enabled`: **True** 1. **REJECTED**: The `Merchant` was rejected by the processor because of invalid information or it failed a regulatory and/or compliance check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and [try verifying the `Merchant` again](#operation/createMerchantVerification). * `processing_enabled`: **False** * `settlement_enabled`: **False** > Provisioning a `Merchant` account is an asynchronous request. We recommend creating a [`Webhook`](#tag/Webhooks) to listen for the state change.

Parameters:

identityId - ID of `Identity` to fetch. (required)

createMerchantUnderwritingRequest - (optional)

Returns:

Merchant

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
201	Single Merchant object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createMerchantWithHttpInfo

public ApiResponse<Merchant> createMerchantWithHttpInfo(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest) throws ApiException

Create a Merchant Create a `Merchant` to start the underwriting process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities). > A bank account must be associated with the previously created `Identity` before a `Merchant` can be succefully onboarded and verified. `Merchant` resources can have three possible `onboarding_states`: 1. **PROVISIONING**: The request is pending (the state may change after two minutes). * `processing_enabled`: **False** * `settlement_enabled`: **False** 1. **APPROVED**: The `Merchant` has been approved and can begin processing payments. * `processing_enabled`: **True** * `settlement_enabled`: **True** 1. **REJECTED**: The `Merchant` was rejected by the processor because of invalid information or it failed a regulatory and/or compliance check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and [try verifying the `Merchant` again](#operation/createMerchantVerification). * `processing_enabled`: **False** * `settlement_enabled`: **False** > Provisioning a `Merchant` account is an asynchronous request. We recommend creating a [`Webhook`](#tag/Webhooks) to listen for the state change.

Parameters:

identityId - ID of `Identity` to fetch. (required)

createMerchantUnderwritingRequest - (optional)

Returns:

ApiResponse<Merchant>

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
201	Single Merchant object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createMerchantAsync

public okhttp3.Call createMerchantAsync(String identityId, CreateMerchantUnderwritingRequest createMerchantUnderwritingRequest, ApiCallback<Merchant> _callback) throws ApiException

Create a Merchant (asynchronously) Create a `Merchant` to start the underwriting process for your merchant. `Merchants` must be created under an [`Identity`](#tag/Identities). > A bank account must be associated with the previously created `Identity` before a `Merchant` can be succefully onboarded and verified. `Merchant` resources can have three possible `onboarding_states`: 1. **PROVISIONING**: The request is pending (the state may change after two minutes). * `processing_enabled`: **False** * `settlement_enabled`: **False** 1. **APPROVED**: The `Merchant` has been approved and can begin processing payments. * `processing_enabled`: **True** * `settlement_enabled`: **True** 1. **REJECTED**: The `Merchant` was rejected by the processor because of invalid information or it failed a regulatory and/or compliance check (e.g. KYC, OFAC, or MATCH). Make any changes that are needed, and [try verifying the `Merchant` again](#operation/createMerchantVerification). * `processing_enabled`: **False** * `settlement_enabled`: **False** > Provisioning a `Merchant` account is an asynchronous request. We recommend creating a [`Webhook`](#tag/Webhooks) to listen for the state change.

Parameters:

identityId - ID of `Identity` to fetch. (required)

createMerchantUnderwritingRequest - (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
201	Single Merchant object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -
422	Error	* finix-apiuser-role - * date - * x-request-id -

createMerchantVerificationCall

public okhttp3.Call createMerchantVerificationCall(String merchantId, CreateVerificationRequest createVerificationRequest, ApiCallback _callback) throws ApiException

Build call for createMerchantVerification

Parameters:

merchantId - ID of `Merchant` object. (required)

createVerificationRequest - (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
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -

createMerchantVerification

public Verification createMerchantVerification(String merchantId, CreateVerificationRequest createVerificationRequest) throws ApiException

Verify a Merchant Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

Parameters:

merchantId - ID of `Merchant` object. (required)

createVerificationRequest - (optional)

Returns:

Verification

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
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -

createMerchantVerificationWithHttpInfo

public ApiResponse<Verification> createMerchantVerificationWithHttpInfo(String merchantId, CreateVerificationRequest createVerificationRequest) throws ApiException

Verify a Merchant Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

Parameters:

merchantId - ID of `Merchant` object. (required)

createVerificationRequest - (optional)

Returns:

ApiResponse<Verification>

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
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -

createMerchantVerificationAsync

public okhttp3.Call createMerchantVerificationAsync(String merchantId, CreateVerificationRequest createVerificationRequest, ApiCallback<Verification> _callback) throws ApiException

Verify a Merchant (asynchronously) Verify a merchant either to reattempt provisioning, or when the merchant's `Identity` was updated.

Parameters:

merchantId - ID of `Merchant` object. (required)

createVerificationRequest - (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
201	Single Verification object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -

getMerchantCall

public okhttp3.Call getMerchantCall(String merchantId, ApiCallback _callback) throws ApiException

Build call for getMerchant

Parameters:

merchantId - ID of `Merchant`. (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 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 Merchant get(String merchantId) throws ApiException

Get a Merchant Retrieve the details of a `Merchant`.

Parameters:

merchantId - ID of `Merchant`. (required)

Returns:

Merchant

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

getMerchantWithHttpInfo

public ApiResponse<Merchant> getMerchantWithHttpInfo(String merchantId) throws ApiException

Get a Merchant Retrieve the details of a `Merchant`.

Parameters:

merchantId - ID of `Merchant`. (required)

Returns:

ApiResponse<Merchant>

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

getMerchantAsync

public okhttp3.Call getMerchantAsync(String merchantId, ApiCallback<Merchant> _callback) throws ApiException

Get a Merchant (asynchronously) Retrieve the details of a `Merchant`.

Parameters:

merchantId - ID of `Merchant`. (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 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 MerchantsList list(ListMerchantsQueryParams listMerchantsQueryParams) throws ApiException

List Merchants Retrieve a list of `Merchants`.

Returns:

APIlistMerchantsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Merchants objects	* finix-apiuser-role - * date - * x-request-id -
400	Error	* 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 -

putMerchantCall

public okhttp3.Call putMerchantCall(String merchantId, UpdateMerchantRequest updateMerchantRequest, ApiCallback _callback) throws ApiException

Build call for putMerchant

Parameters:

merchantId - ID of `Merchant`. (required)

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

update

public Merchant update(String merchantId, UpdateMerchantRequest updateMerchantRequest) throws ApiException

Update a Merchant Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

Parameters:

merchantId - ID of `Merchant`. (required)

updateMerchantRequest - (optional)

Returns:

Merchant

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

putMerchantWithHttpInfo

public ApiResponse<Merchant> putMerchantWithHttpInfo(String merchantId, UpdateMerchantRequest updateMerchantRequest) throws ApiException

Update a Merchant Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

Parameters:

merchantId - ID of `Merchant`. (required)

updateMerchantRequest - (optional)

Returns:

ApiResponse<Merchant>

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

putMerchantAsync

public okhttp3.Call putMerchantAsync(String merchantId, UpdateMerchantRequest updateMerchantRequest, ApiCallback<Merchant> _callback) throws ApiException

Update a Merchant (asynchronously) Update a `Merchant` to change the `Identity` information saved with the underlying processor, or enable Level 2/3 processing.

Parameters:

merchantId - ID of `Merchant`. (required)

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

Class MerchantsApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

MerchantsApi

MerchantsApi

Method Details

getFinixClient

setFinixClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

createMerchantCall

create

createMerchantWithHttpInfo

createMerchantAsync

createMerchantVerificationCall

createMerchantVerification

createMerchantVerificationWithHttpInfo

createMerchantVerificationAsync

getMerchantCall

get

getMerchantWithHttpInfo

getMerchantAsync

list

putMerchantCall

update

putMerchantWithHttpInfo

putMerchantAsync