Package api

Class AuthorizationsApi.APIlistAuthorizationsRequest

java.lang.Object

api.AuthorizationsApi.APIlistAuthorizationsRequest

Enclosing class:

AuthorizationsApi

public class AuthorizationsApi.APIlistAuthorizationsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
AuthorizationsApi.APIlistAuthorizationsRequest	afterCursor(String afterCursor)	Set afterCursor
AuthorizationsApi.APIlistAuthorizationsRequest	amount(Long amount)	Set amount
AuthorizationsApi.APIlistAuthorizationsRequest	amountGt(Long amountGt)	Set amountGt
AuthorizationsApi.APIlistAuthorizationsRequest	amountGte(Long amountGte)	Set amountGte
AuthorizationsApi.APIlistAuthorizationsRequest	amountLt(Long amountLt)	Set amountLt
AuthorizationsApi.APIlistAuthorizationsRequest	amountLte(Long amountLte)	Set amountLte
AuthorizationsApi.APIlistAuthorizationsRequest	beforeCursor(String beforeCursor)	Set beforeCursor
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listAuthorizations
AuthorizationsApi.APIlistAuthorizationsRequest	createdAtGte(String createdAtGte)	Set createdAtGte
AuthorizationsApi.APIlistAuthorizationsRequest	createdAtLte(String createdAtLte)	Set createdAtLte
AuthorizationsList	execute()	Execute listAuthorizations request
okhttp3.Call	executeAsync(ApiCallback<AuthorizationsList> _callback)	Execute listAuthorizations request (asynchronously)
ApiResponse<AuthorizationsList>	executeWithHttpInfo()	Execute listAuthorizations request with HTTP info returned
AuthorizationsApi.APIlistAuthorizationsRequest	idempotencyId(String idempotencyId)	Set idempotencyId
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentAccountLast4(String instrumentAccountLast4)	Set instrumentAccountLast4
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentBin(String instrumentBin)	Set instrumentBin
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentBrandType(String instrumentBrandType)	Set instrumentBrandType
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentCardLast4(String instrumentCardLast4)	Set instrumentCardLast4
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentName(String instrumentName)	Set instrumentName
AuthorizationsApi.APIlistAuthorizationsRequest	instrumentType(String instrumentType)	Set instrumentType
AuthorizationsApi.APIlistAuthorizationsRequest	isVoid(String isVoid)	Set isVoid
AuthorizationsApi.APIlistAuthorizationsRequest	limit(Long limit)	Set limit
AuthorizationsApi.APIlistAuthorizationsRequest	merchantId(String merchantId)	Set merchantId
AuthorizationsApi.APIlistAuthorizationsRequest	merchantIdentityId(String merchantIdentityId)	Set merchantIdentityId
AuthorizationsApi.APIlistAuthorizationsRequest	merchantIdentityName(String merchantIdentityName)	Set merchantIdentityName
AuthorizationsApi.APIlistAuthorizationsRequest	merchantMid(String merchantMid)	Set merchantMid
AuthorizationsApi.APIlistAuthorizationsRequest	merchantProcessorId(String merchantProcessorId)	Set merchantProcessorId
AuthorizationsApi.APIlistAuthorizationsRequest	sort(String sort)	Set sort
AuthorizationsApi.APIlistAuthorizationsRequest	state(String state)	Set state
AuthorizationsApi.APIlistAuthorizationsRequest	traceId(String traceId)	Set traceId
AuthorizationsApi.APIlistAuthorizationsRequest	type(String type)	Set type
AuthorizationsApi.APIlistAuthorizationsRequest	updatedAtGte(String updatedAtGte)	Set updatedAtGte
AuthorizationsApi.APIlistAuthorizationsRequest	updatedAtLte(String updatedAtLte)	Set updatedAtLte

Methods inherited from class java.lang.Object

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

Method Detail

amount

public AuthorizationsApi.APIlistAuthorizationsRequest amount(Long amount)

Set amount

Parameters:

amount - Filter by an amount equal to the given value. (optional)

Returns:

APIlistAuthorizationsRequest

amountGt

public AuthorizationsApi.APIlistAuthorizationsRequest amountGt(Long amountGt)

Set amountGt

Parameters:

amountGt - Filter by an amount greater than. (optional)

Returns:

APIlistAuthorizationsRequest

amountGte

public AuthorizationsApi.APIlistAuthorizationsRequest amountGte(Long amountGte)

Set amountGte

Parameters:

amountGte - Filter by an amount greater than or equal. (optional)

Returns:

APIlistAuthorizationsRequest

amountLt

public AuthorizationsApi.APIlistAuthorizationsRequest amountLt(Long amountLt)

Set amountLt

Parameters:

amountLt - Filter by an amount less than. (optional)

Returns:

APIlistAuthorizationsRequest

amountLte

public AuthorizationsApi.APIlistAuthorizationsRequest amountLte(Long amountLte)

Set amountLte

Parameters:

amountLte - Filter by an amount less than or equal. (optional)

Returns:

APIlistAuthorizationsRequest

beforeCursor

public AuthorizationsApi.APIlistAuthorizationsRequest beforeCursor(String beforeCursor)

Set beforeCursor

Parameters:

beforeCursor - Return every resource created before the cursor value. (optional)

Returns:

APIlistAuthorizationsRequest

createdAtGte

public AuthorizationsApi.APIlistAuthorizationsRequest createdAtGte(String createdAtGte)

Set createdAtGte

Parameters:

createdAtGte - Filter where `created_at` is after the given date. (optional)

Returns:

APIlistAuthorizationsRequest

createdAtLte

public AuthorizationsApi.APIlistAuthorizationsRequest createdAtLte(String createdAtLte)

Set createdAtLte

Parameters:

createdAtLte - Filter where `created_at` is before the given date. (optional)

Returns:

APIlistAuthorizationsRequest

idempotencyId

public AuthorizationsApi.APIlistAuthorizationsRequest idempotencyId(String idempotencyId)

Set idempotencyId

Parameters:

idempotencyId - Filter by `idempotency_id`. (optional)

Returns:

APIlistAuthorizationsRequest

limit

public AuthorizationsApi.APIlistAuthorizationsRequest limit(Long limit)

Set limit

Parameters:

limit - The numbers of items to return. (optional)

Returns:

APIlistAuthorizationsRequest

sort

public AuthorizationsApi.APIlistAuthorizationsRequest sort(String sort)

Set sort

Parameters:

sort - Specify key to be used for sorting the collection. (optional)

Returns:

APIlistAuthorizationsRequest

state

public AuthorizationsApi.APIlistAuthorizationsRequest state(String state)

Set state

Parameters:

state - Filter by Transaction state. (optional)

Returns:

APIlistAuthorizationsRequest

updatedAtGte

public AuthorizationsApi.APIlistAuthorizationsRequest updatedAtGte(String updatedAtGte)

Set updatedAtGte

Parameters:

updatedAtGte - Filter where `updated_at` is after the given date. (optional)

Returns:

APIlistAuthorizationsRequest

updatedAtLte

public AuthorizationsApi.APIlistAuthorizationsRequest updatedAtLte(String updatedAtLte)

Set updatedAtLte

Parameters:

updatedAtLte - Filter where `updated_at` is before the given date. (optional)

Returns:

APIlistAuthorizationsRequest

traceId

public AuthorizationsApi.APIlistAuthorizationsRequest traceId(String traceId)

Set traceId

Parameters:

traceId - Filter by `trace_id`. (optional)

Returns:

APIlistAuthorizationsRequest

isVoid

public AuthorizationsApi.APIlistAuthorizationsRequest isVoid(String isVoid)

Set isVoid

Parameters:

isVoid - Filter by `idempotency_id`. (optional)

Returns:

APIlistAuthorizationsRequest

instrumentBin

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentBin(String instrumentBin)

Set instrumentBin

Parameters:

instrumentBin - Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number. (optional)

Returns:

APIlistAuthorizationsRequest

instrumentAccountLast4

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentAccountLast4(String instrumentAccountLast4)

Set instrumentAccountLast4

Parameters:

instrumentAccountLast4 - Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked number instrument_account_last4=9444 BIN. (optional)

Returns:

APIlistAuthorizationsRequest

instrumentBrandType

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentBrandType(String instrumentBrandType)

Set instrumentBrandType

Parameters:

instrumentBrandType - Filter by card brand. Available card brand types can be found in the drop-down. (optional)

Returns:

APIlistAuthorizationsRequest

merchantIdentityId

public AuthorizationsApi.APIlistAuthorizationsRequest merchantIdentityId(String merchantIdentityId)

Set merchantIdentityId

Parameters:

merchantIdentityId - Filter by `Identity` ID. (optional)

Returns:

APIlistAuthorizationsRequest

merchantIdentityName

public AuthorizationsApi.APIlistAuthorizationsRequest merchantIdentityName(String merchantIdentityName)

Set merchantIdentityName

Parameters:

merchantIdentityName - Filter Transactions by `Identity` name. The name is not case-sensitive. (optional)

Returns:

APIlistAuthorizationsRequest

instrumentName

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentName(String instrumentName)

Set instrumentName

Parameters:

instrumentName - Filter Transactions by `Payment Instrument` name. (optional)

Returns:

APIlistAuthorizationsRequest

instrumentType

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentType(String instrumentType)

Set instrumentType

Parameters:

instrumentType - Filter Transactions by `Payment Instrument` type. Available instrument types include: Bank Account or Payment Card. (optional)

Returns:

APIlistAuthorizationsRequest

merchantId

public AuthorizationsApi.APIlistAuthorizationsRequest merchantId(String merchantId)

Set merchantId

Parameters:

merchantId - Filter by `Merchant` ID. (optional)

Returns:

APIlistAuthorizationsRequest

merchantMid

public AuthorizationsApi.APIlistAuthorizationsRequest merchantMid(String merchantMid)

Set merchantMid

Parameters:

merchantMid - Filter by Merchant Identification Number (MID). (optional)

Returns:

APIlistAuthorizationsRequest

instrumentCardLast4

public AuthorizationsApi.APIlistAuthorizationsRequest instrumentCardLast4(String instrumentCardLast4)

Set instrumentCardLast4

Parameters:

instrumentCardLast4 - Filter by the payment card last 4 digits. (optional)

Returns:

APIlistAuthorizationsRequest

merchantProcessorId

public AuthorizationsApi.APIlistAuthorizationsRequest merchantProcessorId(String merchantProcessorId)

Set merchantProcessorId

Parameters:

merchantProcessorId - Filter by `Processor` ID. (optional)

Returns:

APIlistAuthorizationsRequest

type

public AuthorizationsApi.APIlistAuthorizationsRequest type(String type)

Set type

Parameters:

type - Type of the `Authorization`. (optional)

Returns:

APIlistAuthorizationsRequest

afterCursor

public AuthorizationsApi.APIlistAuthorizationsRequest afterCursor(String afterCursor)

Set afterCursor

Parameters:

afterCursor - Return every resource created after the cursor value. (optional)

Returns:

APIlistAuthorizationsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listAuthorizations

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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 -

execute

public AuthorizationsList execute()
                           throws ApiException

Execute listAuthorizations request

Returns:

AuthorizationsList

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

executeWithHttpInfo

public ApiResponse<AuthorizationsList> executeWithHttpInfo()
                                                    throws ApiException

Execute listAuthorizations request with HTTP info returned

Returns:

ApiResponse<AuthorizationsList>

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

executeAsync

public okhttp3.Call executeAsync(ApiCallback<AuthorizationsList> _callback)
                          throws ApiException

Execute listAuthorizations request (asynchronously)

Parameters:

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