Package api

Class VerificationsApi

java.lang.Object

api.VerificationsApi

public class VerificationsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VerificationsApi.APIlistMerchantVerificationsRequest
class	VerificationsApi.APIlistPaymentInstrumentVerificationsRequest
class	VerificationsApi.APIlistVerificationsRequest

Constructor Summary

Constructors

Constructor	Description
VerificationsApi()
VerificationsApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
Verification	create(CreateVerificationRequest createVerificationRequest)	Create a Merchant Verification Create a `Verification` to verify a merchant's `Identity`.
okhttp3.Call	createVerificationAsync(CreateVerificationRequest createVerificationRequest, ApiCallback<Verification> _callback)	Create a Merchant Verification (asynchronously) Create a `Verification` to verify a merchant's `Identity`.
okhttp3.Call	createVerificationCall(CreateVerificationRequest createVerificationRequest, ApiCallback _callback)	Build call for createVerification
ApiResponse<Verification>	createVerificationWithHttpInfo(CreateVerificationRequest createVerificationRequest)	Create a Merchant Verification Create a `Verification` to verify a merchant's `Identity`.
Verification	get(String verificationId)	Fetch a Verification Retrieve the details of a `Verification`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getVerificationAsync(String verificationId, ApiCallback<Verification> _callback)	Fetch a Verification (asynchronously) Retrieve the details of a `Verification`.
okhttp3.Call	getVerificationCall(String verificationId, ApiCallback _callback)	Build call for getVerification
ApiResponse<Verification>	getVerificationWithHttpInfo(String verificationId)	Fetch a Verification Retrieve the details of a `Verification`.
FinixList	list(ListVerificationsQueryParams listVerificationsQueryParams)	List Verifications Retrieve a list of `Verifications`.
FinixList	listByMerchantId(String merchantId, ListMerchantVerificationsQueryParams listMerchantVerificationsQueryParams)	List Merchant Verifications Get a list of all the `Verifications` for a `Merchant` resource.
FinixList	listByPaymentInstrumentId(String paymentInstrumentId, ListPaymentInstrumentVerificationsQueryParams listPaymentInstrumentVerificationsQueryParams)	List Payment Instrument Verifications List all the `Verifications` created for a `Payment Instrument`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

VerificationsApi

public VerificationsApi()

VerificationsApi

public VerificationsApi(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)

createVerificationCall

public okhttp3.Call createVerificationCall(CreateVerificationRequest createVerificationRequest,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for createVerification

Parameters:

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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

create

public Verification create(CreateVerificationRequest createVerificationRequest)
                    throws ApiException

Create a Merchant Verification Create a `Verification` to verify a merchant's `Identity`. Verifications can also be created directly on the resources you want to verify: - `POST /merchants/{merchant_id}/verifications` Verify `Payment Instruments` directly on the resource: - `POST /payment_instruments/{payment_instrument_id}/verifications`

Parameters:

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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createVerificationWithHttpInfo

public ApiResponse<Verification> createVerificationWithHttpInfo(CreateVerificationRequest createVerificationRequest)
                                                         throws ApiException

Create a Merchant Verification Create a `Verification` to verify a merchant's `Identity`. Verifications can also be created directly on the resources you want to verify: - `POST /merchants/{merchant_id}/verifications` Verify `Payment Instruments` directly on the resource: - `POST /payment_instruments/{payment_instrument_id}/verifications`

Parameters:

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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createVerificationAsync

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

Create a Merchant Verification (asynchronously) Create a `Verification` to verify a merchant's `Identity`. Verifications can also be created directly on the resources you want to verify: - `POST /merchants/{merchant_id}/verifications` Verify `Payment Instruments` directly on the resource: - `POST /payment_instruments/{payment_instrument_id}/verifications`

Parameters:

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 -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

getVerificationCall

public okhttp3.Call getVerificationCall(String verificationId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getVerification

Parameters:

verificationId - ID of `Verification` object. (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 Verification 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 Verification get(String verificationId)
                 throws ApiException

Fetch a Verification Retrieve the details of a `Verification`.

Parameters:

verificationId - ID of `Verification` object. (required)

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
200	Single Verification 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 -

getVerificationWithHttpInfo

public ApiResponse<Verification> getVerificationWithHttpInfo(String verificationId)
                                                      throws ApiException

Fetch a Verification Retrieve the details of a `Verification`.

Parameters:

verificationId - ID of `Verification` object. (required)

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
200	Single Verification 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 -

getVerificationAsync

public okhttp3.Call getVerificationAsync(String verificationId,
                                         ApiCallback<Verification> _callback)
                                  throws ApiException

Fetch a Verification (asynchronously) Retrieve the details of a `Verification`.

Parameters:

verificationId - ID of `Verification` object. (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 Verification 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 -

listByMerchantId

public FinixList listByMerchantId(String merchantId,
                                  ListMerchantVerificationsQueryParams listMerchantVerificationsQueryParams)
                           throws ApiException

List Merchant Verifications Get a list of all the `Verifications` for a `Merchant` resource.

Parameters:

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

Returns:

APIlistMerchantVerificationsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Verification objects	* 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 -

listByPaymentInstrumentId

public FinixList listByPaymentInstrumentId(String paymentInstrumentId,
                                           ListPaymentInstrumentVerificationsQueryParams listPaymentInstrumentVerificationsQueryParams)
                                    throws ApiException

List Payment Instrument Verifications List all the `Verifications` created for a `Payment Instrument`.

Parameters:

paymentInstrumentId - ID of `Payment Instrument `object. (required)

Returns:

APIlistPaymentInstrumentVerificationsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Verification objects	* 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(ListVerificationsQueryParams listVerificationsQueryParams)
               throws ApiException

List Verifications Retrieve a list of `Verifications`.

Returns:

APIlistVerificationsRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Verification objects	* 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 -