Package api

Class TransfersApi.APIlistTransfersRequest

java.lang.Object

api.TransfersApi.APIlistTransfersRequest

Enclosing class:

TransfersApi

public class TransfersApi.APIlistTransfersRequest
extends Object

Method Summary

Modifier and Type	Method	Description
TransfersApi.APIlistTransfersRequest	afterCursor(String afterCursor)	Set afterCursor
TransfersApi.APIlistTransfersRequest	amount(Long amount)	Set amount
TransfersApi.APIlistTransfersRequest	amountGt(Long amountGt)	Set amountGt
TransfersApi.APIlistTransfersRequest	amountGte(Long amountGte)	Set amountGte
TransfersApi.APIlistTransfersRequest	amountLt(Long amountLt)	Set amountLt
TransfersApi.APIlistTransfersRequest	amountLte(Long amountLte)	Set amountLte
TransfersApi.APIlistTransfersRequest	beforeCursor(String beforeCursor)	Set beforeCursor
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listTransfers
TransfersApi.APIlistTransfersRequest	createdAtGte(String createdAtGte)	Set createdAtGte
TransfersApi.APIlistTransfersRequest	createdAtLte(String createdAtLte)	Set createdAtLte
TransfersList	execute()	Execute listTransfers request
okhttp3.Call	executeAsync(ApiCallback<TransfersList> _callback)	Execute listTransfers request (asynchronously)
ApiResponse<TransfersList>	executeWithHttpInfo()	Execute listTransfers request with HTTP info returned
TransfersApi.APIlistTransfersRequest	id(String id)	Set id
TransfersApi.APIlistTransfersRequest	idempotencyId(String idempotencyId)	Set idempotencyId
TransfersApi.APIlistTransfersRequest	instrumentAccountLast4(String instrumentAccountLast4)	Set instrumentAccountLast4
TransfersApi.APIlistTransfersRequest	instrumentBin(String instrumentBin)	Set instrumentBin
TransfersApi.APIlistTransfersRequest	instrumentBrandType(String instrumentBrandType)	Set instrumentBrandType
TransfersApi.APIlistTransfersRequest	instrumentCardLast4(String instrumentCardLast4)	Set instrumentCardLast4
TransfersApi.APIlistTransfersRequest	instrumentName(String instrumentName)	Set instrumentName
TransfersApi.APIlistTransfersRequest	instrumentType(String instrumentType)	Set instrumentType
TransfersApi.APIlistTransfersRequest	limit(Long limit)	Set limit
TransfersApi.APIlistTransfersRequest	merchantId(String merchantId)	Set merchantId
TransfersApi.APIlistTransfersRequest	merchantIdentityId(String merchantIdentityId)	Set merchantIdentityId
TransfersApi.APIlistTransfersRequest	merchantIdentityName(String merchantIdentityName)	Set merchantIdentityName
TransfersApi.APIlistTransfersRequest	merchantMid(String merchantMid)	Set merchantMid
TransfersApi.APIlistTransfersRequest	merchantProcessorId(String merchantProcessorId)	Set merchantProcessorId
TransfersApi.APIlistTransfersRequest	readyToSettleAtGte(String readyToSettleAtGte)	Set readyToSettleAtGte
TransfersApi.APIlistTransfersRequest	readyToSettleAtLte(String readyToSettleAtLte)	Set readyToSettleAtLte
TransfersApi.APIlistTransfersRequest	sort(String sort)	Set sort
TransfersApi.APIlistTransfersRequest	state(String state)	Set state
TransfersApi.APIlistTransfersRequest	statementDescriptor(Long statementDescriptor)	Set statementDescriptor
TransfersApi.APIlistTransfersRequest	traceId(String traceId)	Set traceId
TransfersApi.APIlistTransfersRequest	type(String type)	Set type
TransfersApi.APIlistTransfersRequest	updatedAtGte(String updatedAtGte)	Set updatedAtGte
TransfersApi.APIlistTransfersRequest	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

sort

public TransfersApi.APIlistTransfersRequest sort(String sort)

Set sort

Parameters:

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

Returns:

APIlistTransfersRequest

afterCursor

public TransfersApi.APIlistTransfersRequest afterCursor(String afterCursor)

Set afterCursor

Parameters:

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

Returns:

APIlistTransfersRequest

limit

public TransfersApi.APIlistTransfersRequest limit(Long limit)

Set limit

Parameters:

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

Returns:

APIlistTransfersRequest

amount

public TransfersApi.APIlistTransfersRequest amount(Long amount)

Set amount

Parameters:

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

Returns:

APIlistTransfersRequest

amountGte

public TransfersApi.APIlistTransfersRequest amountGte(Long amountGte)

Set amountGte

Parameters:

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

Returns:

APIlistTransfersRequest

amountGt

public TransfersApi.APIlistTransfersRequest amountGt(Long amountGt)

Set amountGt

Parameters:

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

Returns:

APIlistTransfersRequest

amountLte

public TransfersApi.APIlistTransfersRequest amountLte(Long amountLte)

Set amountLte

Parameters:

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

Returns:

APIlistTransfersRequest

amountLt

public TransfersApi.APIlistTransfersRequest amountLt(Long amountLt)

Set amountLt

Parameters:

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

Returns:

APIlistTransfersRequest

createdAtGte

public TransfersApi.APIlistTransfersRequest createdAtGte(String createdAtGte)

Set createdAtGte

Parameters:

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

Returns:

APIlistTransfersRequest

createdAtLte

public TransfersApi.APIlistTransfersRequest createdAtLte(String createdAtLte)

Set createdAtLte

Parameters:

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

Returns:

APIlistTransfersRequest

idempotencyId

public TransfersApi.APIlistTransfersRequest idempotencyId(String idempotencyId)

Set idempotencyId

Parameters:

idempotencyId - Filter by `idempotency_id`. (optional)

Returns:

APIlistTransfersRequest

id

public TransfersApi.APIlistTransfersRequest id(String id)

Set id

Parameters:

id - Filter by `id`. (optional)

Returns:

APIlistTransfersRequest

state

public TransfersApi.APIlistTransfersRequest state(String state)

Set state

Parameters:

state - Filter by Transaction state. (optional)

Returns:

APIlistTransfersRequest

readyToSettleAtGte

public TransfersApi.APIlistTransfersRequest readyToSettleAtGte(String readyToSettleAtGte)

Set readyToSettleAtGte

Parameters:

readyToSettleAtGte - Filter by `ready_to_settle_at`. (optional)

Returns:

APIlistTransfersRequest

readyToSettleAtLte

public TransfersApi.APIlistTransfersRequest readyToSettleAtLte(String readyToSettleAtLte)

Set readyToSettleAtLte

Parameters:

readyToSettleAtLte - Filter by `ready_to_settle_at`. (optional)

Returns:

APIlistTransfersRequest

statementDescriptor

public TransfersApi.APIlistTransfersRequest statementDescriptor(Long statementDescriptor)

Set statementDescriptor

Parameters:

statementDescriptor - Filter by `statement_descriptor`. (optional)

Returns:

APIlistTransfersRequest

traceId

public TransfersApi.APIlistTransfersRequest traceId(String traceId)

Set traceId

Parameters:

traceId - Filter by `trace_id`. (optional)

Returns:

APIlistTransfersRequest

updatedAtGte

public TransfersApi.APIlistTransfersRequest updatedAtGte(String updatedAtGte)

Set updatedAtGte

Parameters:

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

Returns:

APIlistTransfersRequest

updatedAtLte

public TransfersApi.APIlistTransfersRequest updatedAtLte(String updatedAtLte)

Set updatedAtLte

Parameters:

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

Returns:

APIlistTransfersRequest

instrumentBin

public TransfersApi.APIlistTransfersRequest 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:

APIlistTransfersRequest

instrumentAccountLast4

public TransfersApi.APIlistTransfersRequest 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:

APIlistTransfersRequest

instrumentBrandType

public TransfersApi.APIlistTransfersRequest instrumentBrandType(String instrumentBrandType)

Set instrumentBrandType

Parameters:

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

Returns:

APIlistTransfersRequest

merchantIdentityId

public TransfersApi.APIlistTransfersRequest merchantIdentityId(String merchantIdentityId)

Set merchantIdentityId

Parameters:

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

Returns:

APIlistTransfersRequest

merchantIdentityName

public TransfersApi.APIlistTransfersRequest merchantIdentityName(String merchantIdentityName)

Set merchantIdentityName

Parameters:

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

Returns:

APIlistTransfersRequest

instrumentName

public TransfersApi.APIlistTransfersRequest instrumentName(String instrumentName)

Set instrumentName

Parameters:

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

Returns:

APIlistTransfersRequest

instrumentType

public TransfersApi.APIlistTransfersRequest instrumentType(String instrumentType)

Set instrumentType

Parameters:

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

Returns:

APIlistTransfersRequest

merchantId

public TransfersApi.APIlistTransfersRequest merchantId(String merchantId)

Set merchantId

Parameters:

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

Returns:

APIlistTransfersRequest

merchantMid

public TransfersApi.APIlistTransfersRequest merchantMid(String merchantMid)

Set merchantMid

Parameters:

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

Returns:

APIlistTransfersRequest

instrumentCardLast4

public TransfersApi.APIlistTransfersRequest instrumentCardLast4(String instrumentCardLast4)

Set instrumentCardLast4

Parameters:

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

Returns:

APIlistTransfersRequest

merchantProcessorId

public TransfersApi.APIlistTransfersRequest merchantProcessorId(String merchantProcessorId)

Set merchantProcessorId

Parameters:

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

Returns:

APIlistTransfersRequest

type

public TransfersApi.APIlistTransfersRequest type(String type)

Set type

Parameters:

type - Filter by `Transfer` type. Available type filters include: All, Debits, Refunds, or Credits. (optional)

Returns:

APIlistTransfersRequest

beforeCursor

public TransfersApi.APIlistTransfersRequest beforeCursor(String beforeCursor)

Set beforeCursor

Parameters:

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

Returns:

APIlistTransfersRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listTransfers

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 Transfer 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 TransfersList execute()
                      throws ApiException

Execute listTransfers request

Returns:

TransfersList

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 Transfer 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<TransfersList> executeWithHttpInfo()
                                               throws ApiException

Execute listTransfers request with HTTP info returned

Returns:

ApiResponse<TransfersList>

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 Transfer 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<TransfersList> _callback)
                          throws ApiException

Execute listTransfers 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 Transfer 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 -