Package api

Class ComplianceFormsApi

java.lang.Object

api.ComplianceFormsApi

public class ComplianceFormsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ComplianceFormsApi()
ComplianceFormsApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	getComplianceFormsAsync(String complianceFormsId, ApiCallback<ComplianceForm> _callback)	View Compliance Forms (asynchronously) A webhook notifies you when Finix creates a `compliance_form`.
okhttp3.Call	getComplianceFormsCall(String complianceFormsId, ApiCallback _callback)	Build call for getComplianceForms
ApiResponse<ComplianceForm>	getComplianceFormsWithHttpInfo(String complianceFormsId)	View Compliance Forms A webhook notifies you when Finix creates a `compliance_form`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
ComplianceForm	list(String complianceFormsId)	View Compliance Forms A webhook notifies you when Finix creates a `compliance_form`.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
ComplianceForm	update(String complianceFormsId, UpdateComplianceFormRequest updateComplianceFormRequest)	Complete Compliance Forms As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested.
okhttp3.Call	updateComplianceFormsAsync(String complianceFormsId, UpdateComplianceFormRequest updateComplianceFormRequest, ApiCallback<ComplianceForm> _callback)	Complete Compliance Forms (asynchronously) As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested.
okhttp3.Call	updateComplianceFormsCall(String complianceFormsId, UpdateComplianceFormRequest updateComplianceFormRequest, ApiCallback _callback)	Build call for updateComplianceForms
ApiResponse<ComplianceForm>	updateComplianceFormsWithHttpInfo(String complianceFormsId, UpdateComplianceFormRequest updateComplianceFormRequest)	Complete Compliance Forms As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplianceFormsApi

public ComplianceFormsApi()

ComplianceFormsApi

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

getComplianceFormsCall

public okhttp3.Call getComplianceFormsCall(String complianceFormsId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getComplianceForms

Parameters:

complianceFormsId - ID of the `compliance_form`. (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	Example response	-
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 ComplianceForm list(String complianceFormsId)
                    throws ApiException

View Compliance Forms A webhook notifies you when Finix creates a `compliance_form`. Use the ID in the webhook to fetch the `compliance_form` resource from the `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

Returns:

ComplianceForm

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

getComplianceFormsWithHttpInfo

public ApiResponse<ComplianceForm> getComplianceFormsWithHttpInfo(String complianceFormsId)
                                                           throws ApiException

View Compliance Forms A webhook notifies you when Finix creates a `compliance_form`. Use the ID in the webhook to fetch the `compliance_form` resource from the `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

Returns:

ApiResponse<ComplianceForm>

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

getComplianceFormsAsync

public okhttp3.Call getComplianceFormsAsync(String complianceFormsId,
                                            ApiCallback<ComplianceForm> _callback)
                                     throws ApiException

View Compliance Forms (asynchronously) A webhook notifies you when Finix creates a `compliance_form`. Use the ID in the webhook to fetch the `compliance_form` resource from the `/compliance_forms/:COMPLIANCE_FORM_ID:` endpoint.

Parameters:

complianceFormsId - ID of the `compliance_form`. (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	Example response	-
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 -

updateComplianceFormsCall

public okhttp3.Call updateComplianceFormsCall(String complianceFormsId,
                                              UpdateComplianceFormRequest updateComplianceFormRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for updateComplianceForms

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

updateComplianceFormRequest - (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	Example response	-
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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

update

public ComplianceForm update(String complianceFormsId,
                             UpdateComplianceFormRequest updateComplianceFormRequest)
                      throws ApiException

Complete Compliance Forms As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested. To complete PCI compliance forms: 1. Get the `compliance_form` generated for the merchant using the `ID` from the webhook and present the form to your users when requested. 2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent) to obtain consent. 3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire) information. For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

updateComplianceFormRequest - (optional)

Returns:

ComplianceForm

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	Example response	-
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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

updateComplianceFormsWithHttpInfo

public ApiResponse<ComplianceForm> updateComplianceFormsWithHttpInfo(String complianceFormsId,
                                                                     UpdateComplianceFormRequest updateComplianceFormRequest)
                                                              throws ApiException

Complete Compliance Forms As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested. To complete PCI compliance forms: 1. Get the `compliance_form` generated for the merchant using the `ID` from the webhook and present the form to your users when requested. 2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent) to obtain consent. 3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire) information. For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

updateComplianceFormRequest - (optional)

Returns:

ApiResponse<ComplianceForm>

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	Example response	-
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	Invalid field	* finix-apiuser-role - * date - * x-request-id -

updateComplianceFormsAsync

public okhttp3.Call updateComplianceFormsAsync(String complianceFormsId,
                                               UpdateComplianceFormRequest updateComplianceFormRequest,
                                               ApiCallback<ComplianceForm> _callback)
                                        throws ApiException

Complete Compliance Forms (asynchronously) As part of onboarding your users, you'll need to build a UI experience that allows users to complete the PCI `compliance_form` and download the form as a PDF if requested. To complete PCI compliance forms: 1. Get the `compliance_form` generated for the merchant using the `ID` from the webhook and present the form to your users when requested. 2. Show your users the [required text](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#obtaining-compliance-consent) to obtain consent. 3. Submit a PUT API request with the necessary [attestation](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-the-questionnaire) information. For more information, see [Managing Compliance Forms](/guides/security-and-compliance/pci-dss-compliance/managing-pci-compliance/#completing-compliance-forms).

Parameters:

complianceFormsId - ID of the `compliance_form`. (required)

updateComplianceFormRequest - (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	Example response	-
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	Invalid field	* finix-apiuser-role - * date - * x-request-id -