Package com.plaid.client.model
Class BankTransferEventListRequest
java.lang.Object
com.plaid.client.model.BankTransferEventListRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2021-10-15T19:47:39.714Z[GMT]")
public class BankTransferEventListRequest
extends java.lang.Object
Defines the request schema for `/bank_transfer/event/list`
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BankTransferEventListRequest.BankTransferTypeEnum
The type of bank transfer.static class
BankTransferEventListRequest.DirectionEnum
Indicates the direction of the transfer: `outbound`: for API-initiated transfers `inbound`: for payments received by the FBO account. -
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SERIALIZED_NAME_ACCOUNT_ID
static java.lang.String
SERIALIZED_NAME_BANK_TRANSFER_ID
static java.lang.String
SERIALIZED_NAME_BANK_TRANSFER_TYPE
static java.lang.String
SERIALIZED_NAME_CLIENT_ID
static java.lang.String
SERIALIZED_NAME_COUNT
static java.lang.String
SERIALIZED_NAME_DIRECTION
static java.lang.String
SERIALIZED_NAME_END_DATE
static java.lang.String
SERIALIZED_NAME_EVENT_TYPES
static java.lang.String
SERIALIZED_NAME_OFFSET
static java.lang.String
SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static java.lang.String
SERIALIZED_NAME_SECRET
static java.lang.String
SERIALIZED_NAME_START_DATE
-
Constructor Summary
Constructors Constructor Description BankTransferEventListRequest()
-
Method Summary
Modifier and Type Method Description BankTransferEventListRequest
accountId(java.lang.String accountId)
BankTransferEventListRequest
addEventTypesItem(BankTransferEventType eventTypesItem)
BankTransferEventListRequest
bankTransferId(java.lang.String bankTransferId)
BankTransferEventListRequest
bankTransferType(BankTransferEventListRequest.BankTransferTypeEnum bankTransferType)
BankTransferEventListRequest
clientId(java.lang.String clientId)
BankTransferEventListRequest
count(java.lang.Integer count)
BankTransferEventListRequest
direction(BankTransferEventListRequest.DirectionEnum direction)
BankTransferEventListRequest
endDate(java.time.OffsetDateTime endDate)
boolean
equals(java.lang.Object o)
BankTransferEventListRequest
eventTypes(java.util.List<BankTransferEventType> eventTypes)
java.lang.String
getAccountId()
The account ID to get events for all transactions to/from an account.java.lang.String
getBankTransferId()
Plaid’s unique identifier for a bank transfer.BankTransferEventListRequest.BankTransferTypeEnum
getBankTransferType()
The type of bank transfer.java.lang.String
getClientId()
Your Plaid API `client_id`.java.lang.Integer
getCount()
The maximum number of bank transfer events to return.BankTransferEventListRequest.DirectionEnum
getDirection()
Indicates the direction of the transfer: `outbound`: for API-initiated transfers `inbound`: for payments received by the FBO account.java.time.OffsetDateTime
getEndDate()
The end datetime of bank transfers to list.java.util.List<BankTransferEventType>
getEventTypes()
Filter events by event type.java.lang.Integer
getOffset()
The offset into the list of bank transfer events.java.lang.String
getOriginationAccountId()
The origination account ID to get events for transfers from a specific origination account.java.lang.String
getSecret()
Your Plaid API `secret`.java.time.OffsetDateTime
getStartDate()
The start datetime of bank transfers to list.int
hashCode()
BankTransferEventListRequest
offset(java.lang.Integer offset)
BankTransferEventListRequest
originationAccountId(java.lang.String originationAccountId)
BankTransferEventListRequest
secret(java.lang.String secret)
void
setAccountId(java.lang.String accountId)
void
setBankTransferId(java.lang.String bankTransferId)
void
setBankTransferType(BankTransferEventListRequest.BankTransferTypeEnum bankTransferType)
void
setClientId(java.lang.String clientId)
void
setCount(java.lang.Integer count)
void
setDirection(BankTransferEventListRequest.DirectionEnum direction)
void
setEndDate(java.time.OffsetDateTime endDate)
void
setEventTypes(java.util.List<BankTransferEventType> eventTypes)
void
setOffset(java.lang.Integer offset)
void
setOriginationAccountId(java.lang.String originationAccountId)
void
setSecret(java.lang.String secret)
void
setStartDate(java.time.OffsetDateTime startDate)
BankTransferEventListRequest
startDate(java.time.OffsetDateTime startDate)
java.lang.String
toString()
-
Field Details
-
SERIALIZED_NAME_CLIENT_ID
public static final java.lang.String SERIALIZED_NAME_CLIENT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SECRET
public static final java.lang.String SERIALIZED_NAME_SECRET- See Also:
- Constant Field Values
-
SERIALIZED_NAME_START_DATE
public static final java.lang.String SERIALIZED_NAME_START_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_END_DATE
public static final java.lang.String SERIALIZED_NAME_END_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BANK_TRANSFER_ID
public static final java.lang.String SERIALIZED_NAME_BANK_TRANSFER_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCOUNT_ID
public static final java.lang.String SERIALIZED_NAME_ACCOUNT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BANK_TRANSFER_TYPE
public static final java.lang.String SERIALIZED_NAME_BANK_TRANSFER_TYPE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EVENT_TYPES
public static final java.lang.String SERIALIZED_NAME_EVENT_TYPES- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COUNT
public static final java.lang.String SERIALIZED_NAME_COUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_OFFSET
public static final java.lang.String SERIALIZED_NAME_OFFSET- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
public static final java.lang.String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DIRECTION
public static final java.lang.String SERIALIZED_NAME_DIRECTION- See Also:
- Constant Field Values
-
-
Constructor Details
-
BankTransferEventListRequest
public BankTransferEventListRequest()
-
-
Method Details
-
clientId
-
getClientId
@Nullable public java.lang.String getClientId()Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.- Returns:
- clientId
-
setClientId
public void setClientId(java.lang.String clientId) -
secret
-
getSecret
@Nullable public java.lang.String getSecret()Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.- Returns:
- secret
-
setSecret
public void setSecret(java.lang.String secret) -
startDate
-
getStartDate
@Nullable public java.time.OffsetDateTime getStartDate()The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)- Returns:
- startDate
-
setStartDate
public void setStartDate(java.time.OffsetDateTime startDate) -
endDate
-
getEndDate
@Nullable public java.time.OffsetDateTime getEndDate()The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)- Returns:
- endDate
-
setEndDate
public void setEndDate(java.time.OffsetDateTime endDate) -
bankTransferId
-
getBankTransferId
@Nullable public java.lang.String getBankTransferId()Plaid’s unique identifier for a bank transfer.- Returns:
- bankTransferId
-
setBankTransferId
public void setBankTransferId(java.lang.String bankTransferId) -
accountId
-
getAccountId
@Nullable public java.lang.String getAccountId()The account ID to get events for all transactions to/from an account.- Returns:
- accountId
-
setAccountId
public void setAccountId(java.lang.String accountId) -
bankTransferType
public BankTransferEventListRequest bankTransferType(BankTransferEventListRequest.BankTransferTypeEnum bankTransferType) -
getBankTransferType
The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into your origination account; a `credit` indicates a transfer of money out of your origination account.- Returns:
- bankTransferType
-
setBankTransferType
public void setBankTransferType(BankTransferEventListRequest.BankTransferTypeEnum bankTransferType) -
eventTypes
-
addEventTypesItem
-
getEventTypes
Filter events by event type.- Returns:
- eventTypes
-
setEventTypes
-
count
-
getCount
@Nullable public java.lang.Integer getCount()The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned. minimum: 1 maximum: 25- Returns:
- count
-
setCount
public void setCount(java.lang.Integer count) -
offset
-
getOffset
@Nullable public java.lang.Integer getOffset()The offset into the list of bank transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned. minimum: 0- Returns:
- offset
-
setOffset
public void setOffset(java.lang.Integer offset) -
originationAccountId
-
getOriginationAccountId
@Nullable public java.lang.String getOriginationAccountId()The origination account ID to get events for transfers from a specific origination account.- Returns:
- originationAccountId
-
setOriginationAccountId
public void setOriginationAccountId(java.lang.String originationAccountId) -
direction
public BankTransferEventListRequest direction(BankTransferEventListRequest.DirectionEnum direction) -
getDirection
Indicates the direction of the transfer: `outbound`: for API-initiated transfers `inbound`: for payments received by the FBO account.- Returns:
- direction
-
setDirection
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-