TransferAuthorizationCreateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.TransferAuthorizationCreateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class TransferAuthorizationCreateRequest
extends Object

Defines the request schema for `/transfer/authorization/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCESS_TOKEN`
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_ACH_CLASS`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_BEACON_SESSION_ID`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CREDIT_FUNDS_SOURCE`
`static String`	`SERIALIZED_NAME_DEVICE`
`static String`	`SERIALIZED_NAME_FUNDING_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_NETWORK`
`static String`	`SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_ORIGINATOR_CLIENT_ID`
`static String`	`SERIALIZED_NAME_PAYMENT_PROFILE_TOKEN`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TEST_CLOCK_ID`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_USER_PRESENT`
`static String`	`SERIALIZED_NAME_WITH_GUARANTEE`

Constructor Summary

Constructors
Constructor and Description

TransferAuthorizationCreateRequest()

Constructors
Constructor and Description
`TransferAuthorizationCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferAuthorizationCreateRequest`	`accessToken(String accessToken)`
`TransferAuthorizationCreateRequest`	`accountId(String accountId)`
`TransferAuthorizationCreateRequest`	`achClass(ACHClass achClass)`
`TransferAuthorizationCreateRequest`	`amount(String amount)`
`TransferAuthorizationCreateRequest`	`beaconSessionId(String beaconSessionId)`
`TransferAuthorizationCreateRequest`	`clientId(String clientId)`
`TransferAuthorizationCreateRequest`	`creditFundsSource(TransferCreditFundsSource creditFundsSource)`
`TransferAuthorizationCreateRequest`	`device(TransferAuthorizationDevice device)`
`boolean`	`equals(Object o)`
`TransferAuthorizationCreateRequest`	`fundingAccountId(String fundingAccountId)`
`String`	`getAccessToken()` The Plaid `access_token` for the account that will be debited or credited.
`String`	`getAccountId()` The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
`ACHClass`	`getAchClass()` Get achClass
`String`	`getAmount()` The amount of the transfer (decimal string with two digits of precision e.g.
`String`	`getBeaconSessionId()` The unique identifier returned by Plaid's [beacon](https://plaid.com/docs/transfer/guarantee/#using-a-beacon) when it is run on your webpage.
`String`	`getClientId()` Your Plaid API `client_id`.
`TransferCreditFundsSource`	`getCreditFundsSource()` Get creditFundsSource
`TransferAuthorizationDevice`	`getDevice()` Get device
`String`	`getFundingAccountId()` Specify the account used to fund the transfer.
`String`	`getIdempotencyKey()` A random key provided by the client, per unique authorization, which expires after 48 hours.
`String`	`getIsoCurrencyCode()` The currency of the transfer amount.
`TransferNetwork`	`getNetwork()` Get network
`String`	`getOriginationAccountId()` Plaid's unique identifier for the origination account for this authorization.
`String`	`getOriginatorClientId()` The Plaid client ID that is the originator of this transfer.
`String`	`getPaymentProfileToken()` The payment profile token associated with the Payment Profile that will be debited or credited.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTestClockId()` Plaid’s unique identifier for a test clock.
`TransferType`	`getType()` Get type
`TransferAuthorizationUserInRequest`	`getUser()` Get user
`Boolean`	`getUserPresent()` If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`.
`Boolean`	`getWithGuarantee()` If set to `false`, Plaid will not offer a `guarantee_decision` for this request (Guarantee customers only).
`int`	`hashCode()`
`TransferAuthorizationCreateRequest`	`idempotencyKey(String idempotencyKey)`
`TransferAuthorizationCreateRequest`	`isoCurrencyCode(String isoCurrencyCode)`
`TransferAuthorizationCreateRequest`	`network(TransferNetwork network)`
`TransferAuthorizationCreateRequest`	`originationAccountId(String originationAccountId)`
`TransferAuthorizationCreateRequest`	`originatorClientId(String originatorClientId)`
`TransferAuthorizationCreateRequest`	`paymentProfileToken(String paymentProfileToken)`
`TransferAuthorizationCreateRequest`	`secret(String secret)`
`void`	`setAccessToken(String accessToken)`
`void`	`setAccountId(String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setBeaconSessionId(String beaconSessionId)`
`void`	`setClientId(String clientId)`
`void`	`setCreditFundsSource(TransferCreditFundsSource creditFundsSource)`
`void`	`setDevice(TransferAuthorizationDevice device)`
`void`	`setFundingAccountId(String fundingAccountId)`
`void`	`setIdempotencyKey(String idempotencyKey)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setNetwork(TransferNetwork network)`
`void`	`setOriginationAccountId(String originationAccountId)`
`void`	`setOriginatorClientId(String originatorClientId)`
`void`	`setPaymentProfileToken(String paymentProfileToken)`
`void`	`setSecret(String secret)`
`void`	`setTestClockId(String testClockId)`
`void`	`setType(TransferType type)`
`void`	`setUser(TransferAuthorizationUserInRequest user)`
`void`	`setUserPresent(Boolean userPresent)`
`void`	`setWithGuarantee(Boolean withGuarantee)`
`TransferAuthorizationCreateRequest`	`testClockId(String testClockId)`
`String`	`toString()`
`TransferAuthorizationCreateRequest`	`type(TransferType type)`
`TransferAuthorizationCreateRequest`	`user(TransferAuthorizationUserInRequest user)`
`TransferAuthorizationCreateRequest`	`userPresent(Boolean userPresent)`
`TransferAuthorizationCreateRequest`	`withGuarantee(Boolean withGuarantee)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CLIENT_ID
```
public static final String SERIALIZED_NAME_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECRET
```
public static final String SERIALIZED_NAME_SECRET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCESS_TOKEN
```
public static final String SERIALIZED_NAME_ACCESS_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FUNDING_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_FUNDING_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_PROFILE_TOKEN
```
public static final String SERIALIZED_NAME_PAYMENT_PROFILE_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NETWORK
```
public static final String SERIALIZED_NAME_NETWORK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACH_CLASS
```
public static final String SERIALIZED_NAME_ACH_CLASS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DEVICE
```
public static final String SERIALIZED_NAME_DEVICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISO_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IDEMPOTENCY_KEY
```
public static final String SERIALIZED_NAME_IDEMPOTENCY_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER_PRESENT
```
public static final String SERIALIZED_NAME_USER_PRESENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WITH_GUARANTEE
```
public static final String SERIALIZED_NAME_WITH_GUARANTEE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BEACON_SESSION_ID
```
public static final String SERIALIZED_NAME_BEACON_SESSION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORIGINATOR_CLIENT_ID
```
public static final String SERIALIZED_NAME_ORIGINATOR_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREDIT_FUNDS_SOURCE
```
public static final String SERIALIZED_NAME_CREDIT_FUNDS_SOURCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEST_CLOCK_ID
```
public static final String SERIALIZED_NAME_TEST_CLOCK_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferAuthorizationCreateRequest
```
public TransferAuthorizationCreateRequest()
```
- Method Detail
  - clientId
```
public TransferAuthorizationCreateRequest clientId(String clientId)
```
  - getClientId
```
@Nullable
public 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(String clientId)
```
  - secret
```
public TransferAuthorizationCreateRequest secret(String secret)
```
  - getSecret
```
@Nullable
public 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(String secret)
```
  - accessToken
```
public TransferAuthorizationCreateRequest accessToken(String accessToken)
```
  - getAccessToken
```
public String getAccessToken()
```
    The Plaid `access_token` for the account that will be debited or credited.
    
    Returns:
    
    accessToken
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
  - accountId
```
public TransferAuthorizationCreateRequest accountId(String accountId)
```
  - getAccountId
```
public String getAccountId()
```
    The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - fundingAccountId
```
public TransferAuthorizationCreateRequest fundingAccountId(String fundingAccountId)
```
  - getFundingAccountId
```
@Nullable
public String getFundingAccountId()
```
    Specify the account used to fund the transfer. Should be specified if using legacy funding methods only. If using Plaid Ledger, leave this field blank. Customers can find a list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the \"Account ID\" column. If this field is left blank and you are using legacy funding methods, this will default to the default `funding_account_id` specified during onboarding. Otherwise, Plaid Ledger will be used.
    
    Returns:
    
    fundingAccountId
  - setFundingAccountId
```
public void setFundingAccountId(String fundingAccountId)
```
  - paymentProfileToken
```
public TransferAuthorizationCreateRequest paymentProfileToken(String paymentProfileToken)
```
  - getPaymentProfileToken
```
@Nullable
public String getPaymentProfileToken()
```
    The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using `access_token`.
    
    Returns:
    
    paymentProfileToken
  - setPaymentProfileToken
```
public void setPaymentProfileToken(String paymentProfileToken)
```
  - type
```
public TransferAuthorizationCreateRequest type(TransferType type)
```
  - getType
```
public TransferType getType()
```
    Get type
    
    Returns:
    
    type
  - setType
```
public void setType(TransferType type)
```
  - network
```
public TransferAuthorizationCreateRequest network(TransferNetwork network)
```
  - getNetwork
```
public TransferNetwork getNetwork()
```
    Get network
    
    Returns:
    
    network
  - setNetwork
```
public void setNetwork(TransferNetwork network)
```
  - amount
```
public TransferAuthorizationCreateRequest amount(String amount)
```
  - getAmount
```
public String getAmount()
```
    The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\").
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - achClass
```
public TransferAuthorizationCreateRequest achClass(ACHClass achClass)
```
  - getAchClass
```
@Nullable
public ACHClass getAchClass()
```
    Get achClass
    
    Returns:
    
    achClass
  - setAchClass
```
public void setAchClass(ACHClass achClass)
```
  - user
```
public TransferAuthorizationCreateRequest user(TransferAuthorizationUserInRequest user)
```
  - getUser
```
public TransferAuthorizationUserInRequest getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(TransferAuthorizationUserInRequest user)
```
  - device
```
public TransferAuthorizationCreateRequest device(TransferAuthorizationDevice device)
```
  - getDevice
```
@Nullable
public TransferAuthorizationDevice getDevice()
```
    Get device
    
    Returns:
    
    device
  - setDevice
```
public void setDevice(TransferAuthorizationDevice device)
```
  - originationAccountId
```
public TransferAuthorizationCreateRequest originationAccountId(String originationAccountId)
```
  - getOriginationAccountId
```
@Nullable
public String getOriginationAccountId()
```
    Plaid's unique identifier for the origination account for this authorization. If not specified, the default account will be used.
    
    Returns:
    
    originationAccountId
  - setOriginationAccountId
```
public void setOriginationAccountId(String originationAccountId)
```
  - isoCurrencyCode
```
public TransferAuthorizationCreateRequest isoCurrencyCode(String isoCurrencyCode)
```
  - getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
    The currency of the transfer amount. The default value is \"USD\".
    
    Returns:
    
    isoCurrencyCode
  - setIsoCurrencyCode
```
public void setIsoCurrencyCode(String isoCurrencyCode)
```
  - idempotencyKey
```
public TransferAuthorizationCreateRequest idempotencyKey(String idempotencyKey)
```
  - getIdempotencyKey
```
@Nullable
public String getIdempotencyKey()
```
    A random key provided by the client, per unique authorization, which expires after 48 hours. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create an authorization fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single authorization is created. This idempotency key expires after 48 hours, after which the same key can be reused. Failure to provide this key may result in duplicate charges.
    
    Returns:
    
    idempotencyKey
  - setIdempotencyKey
```
public void setIdempotencyKey(String idempotencyKey)
```
  - userPresent
```
public TransferAuthorizationCreateRequest userPresent(Boolean userPresent)
```
  - getUserPresent
```
@Nullable
public Boolean getUserPresent()
```
    If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`. This field is not currently used and is present to support planned future functionality.
    
    Returns:
    
    userPresent
  - setUserPresent
```
public void setUserPresent(Boolean userPresent)
```
  - withGuarantee
```
public TransferAuthorizationCreateRequest withGuarantee(Boolean withGuarantee)
```
  - getWithGuarantee
```
@Nullable
public Boolean getWithGuarantee()
```
    If set to `false`, Plaid will not offer a `guarantee_decision` for this request (Guarantee customers only).
    
    Returns:
    
    withGuarantee
  - setWithGuarantee
```
public void setWithGuarantee(Boolean withGuarantee)
```
  - beaconSessionId
```
public TransferAuthorizationCreateRequest beaconSessionId(String beaconSessionId)
```
  - getBeaconSessionId
```
@Nullable
public String getBeaconSessionId()
```
    The unique identifier returned by Plaid's [beacon](https://plaid.com/docs/transfer/guarantee/#using-a-beacon) when it is run on your webpage.
    
    Returns:
    
    beaconSessionId
  - setBeaconSessionId
```
public void setBeaconSessionId(String beaconSessionId)
```
  - originatorClientId
```
public TransferAuthorizationCreateRequest originatorClientId(String originatorClientId)
```
  - getOriginatorClientId
```
@Nullable
public String getOriginatorClientId()
```
    The Plaid client ID that is the originator of this transfer. Only needed if creating transfers on behalf of another client as a [Platform customer](https://plaid.com/docs/transfer/application/#originators-vs-platforms).
    
    Returns:
    
    originatorClientId
  - setOriginatorClientId
```
public void setOriginatorClientId(String originatorClientId)
```
  - creditFundsSource
```
public TransferAuthorizationCreateRequest creditFundsSource(TransferCreditFundsSource creditFundsSource)
```
  - getCreditFundsSource
```
@Nullable
public TransferCreditFundsSource getCreditFundsSource()
```
    Get creditFundsSource
    
    Returns:
    
    creditFundsSource
  - setCreditFundsSource
```
public void setCreditFundsSource(TransferCreditFundsSource creditFundsSource)
```
  - testClockId
```
public TransferAuthorizationCreateRequest testClockId(String testClockId)
```
  - getTestClockId
```
@Nullable
public String getTestClockId()
```
    Plaid’s unique identifier for a test clock. This field may only be used when using `sandbox` environment. If provided, the `authorization` is created at the `virtual_time` on the provided test clock.
    
    Returns:
    
    testClockId
  - setTestClockId
```
public void setTestClockId(String testClockId)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TransferAuthorizationCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_ACCESS_TOKEN

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_FUNDING_ACCOUNT_ID

SERIALIZED_NAME_PAYMENT_PROFILE_TOKEN

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_USER

SERIALIZED_NAME_DEVICE

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_IDEMPOTENCY_KEY

SERIALIZED_NAME_USER_PRESENT

SERIALIZED_NAME_WITH_GUARANTEE

SERIALIZED_NAME_BEACON_SESSION_ID

SERIALIZED_NAME_ORIGINATOR_CLIENT_ID

SERIALIZED_NAME_CREDIT_FUNDS_SOURCE

SERIALIZED_NAME_TEST_CLOCK_ID

Constructor Detail

TransferAuthorizationCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

accessToken

getAccessToken

setAccessToken

accountId

getAccountId

setAccountId

fundingAccountId

getFundingAccountId

setFundingAccountId

paymentProfileToken

getPaymentProfileToken

setPaymentProfileToken

type

getType

setType

network

getNetwork

setNetwork

amount

getAmount

setAmount

achClass

getAchClass

setAchClass

user

getUser

setUser

device

getDevice

setDevice

originationAccountId

getOriginationAccountId

setOriginationAccountId

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

idempotencyKey

getIdempotencyKey

setIdempotencyKey

userPresent

getUserPresent

setUserPresent

withGuarantee

getWithGuarantee