Package api

Class AuthorizationsApi

java.lang.Object

api.AuthorizationsApi

public class AuthorizationsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AuthorizationsApi.APIlistAuthorizationsRequest

Constructor Summary

Constructors

Constructor	Description
AuthorizationsApi()
AuthorizationsApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
Authorization	create(CreateAuthorizationRequest createAuthorizationRequest)	Create an Authorization Create an `Authorization` to process a transaction.
okhttp3.Call	createAuthorizationAsync(CreateAuthorizationRequest createAuthorizationRequest, ApiCallback<Authorization> _callback)	Create an Authorization (asynchronously) Create an `Authorization` to process a transaction.
okhttp3.Call	createAuthorizationCall(CreateAuthorizationRequest createAuthorizationRequest, ApiCallback _callback)	Build call for createAuthorization
ApiResponse<Authorization>	createAuthorizationWithHttpInfo(CreateAuthorizationRequest createAuthorizationRequest)	Create an Authorization Create an `Authorization` to process a transaction.
Authorization	get(String authorizationId)	Get an Authorization Retrieve the details of a previously created `Authorization`.
okhttp3.Call	getAuthorizationAsync(String authorizationId, ApiCallback<Authorization> _callback)	Get an Authorization (asynchronously) Retrieve the details of a previously created `Authorization`.
okhttp3.Call	getAuthorizationCall(String authorizationId, ApiCallback _callback)	Build call for getAuthorization
ApiResponse<Authorization>	getAuthorizationWithHttpInfo(String authorizationId)	Get an Authorization Retrieve the details of a previously created `Authorization`.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
AuthorizationsList	list(ListAuthorizationsQueryParams listAuthorizationsQueryParams)	List Authorizations Retrieve a list of `Authorizations`.
okhttp3.Call	putAuthorizationAsync(String authorizationId, UpdateAuthorizationRequest updateAuthorizationRequest, ApiCallback<Authorization> _callback)	Update an Authorization (asynchronously) If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds.
okhttp3.Call	putAuthorizationCall(String authorizationId, UpdateAuthorizationRequest updateAuthorizationRequest, ApiCallback _callback)	Build call for putAuthorization
ApiResponse<Authorization>	putAuthorizationWithHttpInfo(String authorizationId, UpdateAuthorizationRequest updateAuthorizationRequest)	Update an Authorization If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)
Authorization	update(String authorizationId, UpdateAuthorizationRequest updateAuthorizationRequest)	Update an Authorization If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizationsApi

public AuthorizationsApi()

AuthorizationsApi

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

createAuthorizationCall

public okhttp3.Call createAuthorizationCall(CreateAuthorizationRequest createAuthorizationRequest,
 ApiCallback _callback)
                                     throws ApiException

Build call for createAuthorization

Parameters:

createAuthorizationRequest - (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 Authorization 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 -
402	Payment Required	* 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 -

create

public Authorization create(CreateAuthorizationRequest createAuthorizationRequest)
                     throws ApiException

Create an Authorization Create an `Authorization` to process a transaction. `Authorizations` can have two possible `states`: - **SUCCEEDED** - **FAILED** If the `Authorization` has **SUCCEEDED** , it must be captured before `expires_at` passes or the funds will be released. Learn how to prevent duplicate authorizations by passing an [Idempotency ID](#section/Idempotency-Requests) in the payload.

Parameters:

createAuthorizationRequest - (optional)

Returns:

Authorization

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 Authorization 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 -
402	Payment Required	* 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 -

createAuthorizationWithHttpInfo

public ApiResponse<Authorization> createAuthorizationWithHttpInfo(CreateAuthorizationRequest createAuthorizationRequest)
                                                           throws ApiException

Create an Authorization Create an `Authorization` to process a transaction. `Authorizations` can have two possible `states`: - **SUCCEEDED** - **FAILED** If the `Authorization` has **SUCCEEDED** , it must be captured before `expires_at` passes or the funds will be released. Learn how to prevent duplicate authorizations by passing an [Idempotency ID](#section/Idempotency-Requests) in the payload.

Parameters:

createAuthorizationRequest - (optional)

Returns:

ApiResponse<Authorization>

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 Authorization 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 -
402	Payment Required	* 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 -

createAuthorizationAsync

public okhttp3.Call createAuthorizationAsync(CreateAuthorizationRequest createAuthorizationRequest,
 ApiCallback<Authorization> _callback)
                                      throws ApiException

Create an Authorization (asynchronously) Create an `Authorization` to process a transaction. `Authorizations` can have two possible `states`: - **SUCCEEDED** - **FAILED** If the `Authorization` has **SUCCEEDED** , it must be captured before `expires_at` passes or the funds will be released. Learn how to prevent duplicate authorizations by passing an [Idempotency ID](#section/Idempotency-Requests) in the payload.

Parameters:

createAuthorizationRequest - (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 Authorization 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 -
402	Payment Required	* 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 -

getAuthorizationCall

public okhttp3.Call getAuthorizationCall(String authorizationId,
 ApiCallback _callback)
                                  throws ApiException

Build call for getAuthorization

Parameters:

authorizationId - ID of authorization to fetch (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 Authorization 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 Authorization get(String authorizationId)
                  throws ApiException

Get an Authorization Retrieve the details of a previously created `Authorization`.

Parameters:

authorizationId - ID of authorization to fetch (required)

Returns:

Authorization

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

getAuthorizationWithHttpInfo

public ApiResponse<Authorization> getAuthorizationWithHttpInfo(String authorizationId)
                                                        throws ApiException

Get an Authorization Retrieve the details of a previously created `Authorization`.

Parameters:

authorizationId - ID of authorization to fetch (required)

Returns:

ApiResponse<Authorization>

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

getAuthorizationAsync

public okhttp3.Call getAuthorizationAsync(String authorizationId,
 ApiCallback<Authorization> _callback)
                                   throws ApiException

Get an Authorization (asynchronously) Retrieve the details of a previously created `Authorization`.

Parameters:

authorizationId - ID of authorization to fetch (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 Authorization 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 AuthorizationsList list(ListAuthorizationsQueryParams listAuthorizationsQueryParams)
                        throws ApiException

List Authorizations Retrieve a list of `Authorizations`.

Returns:

APIlistAuthorizationsRequest

Throws:

ApiException

Http Response Details:

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

putAuthorizationCall

public okhttp3.Call putAuthorizationCall(String authorizationId,
 UpdateAuthorizationRequest updateAuthorizationRequest,
 ApiCallback _callback)
                                  throws ApiException

Build call for putAuthorization

Parameters:

authorizationId - ID of authorization to fetch (required)

updateAuthorizationRequest - (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 Authorization 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

update

public Authorization update(String authorizationId,
 UpdateAuthorizationRequest updateAuthorizationRequest)
                     throws ApiException

Update an Authorization If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds. By default, `Transfers` are in a **PENDING** state. The **PENDING** state means the system hasn't submitted the request to capture funds. Capture requests get submitted via a batch request. Once the `Authorization` is updated with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will update to **SUCCEEDED**. > Voided `Authorizations` can't be captured.

Parameters:

authorizationId - ID of authorization to fetch (required)

updateAuthorizationRequest - (optional)

Returns:

Authorization

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

putAuthorizationWithHttpInfo

public ApiResponse<Authorization> putAuthorizationWithHttpInfo(String authorizationId,
 UpdateAuthorizationRequest updateAuthorizationRequest)
                                                        throws ApiException

Update an Authorization If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds. By default, `Transfers` are in a **PENDING** state. The **PENDING** state means the system hasn't submitted the request to capture funds. Capture requests get submitted via a batch request. Once the `Authorization` is updated with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will update to **SUCCEEDED**. > Voided `Authorizations` can't be captured.

Parameters:

authorizationId - ID of authorization to fetch (required)

updateAuthorizationRequest - (optional)

Returns:

ApiResponse<Authorization>

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

putAuthorizationAsync

public okhttp3.Call putAuthorizationAsync(String authorizationId,
 UpdateAuthorizationRequest updateAuthorizationRequest,
 ApiCallback<Authorization> _callback)
                                   throws ApiException

Update an Authorization (asynchronously) If successfully captured, the `transfer` field of the `Authorization` will contain the ID of the `Transfer` resource that'll move funds. By default, `Transfers` are in a **PENDING** state. The **PENDING** state means the system hasn't submitted the request to capture funds. Capture requests get submitted via a batch request. Once the `Authorization` is updated with a `capture_amount` (i.e. *Captured*), the state of the `Transfer` will update to **SUCCEEDED**. > Voided `Authorizations` can't be captured.

Parameters:

authorizationId - ID of authorization to fetch (required)

updateAuthorizationRequest - (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 Authorization 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 -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -