All Implemented Interfaces:: com.increase.api.core.Params


public final class RealTimePaymentsTransferCreateParams
 implements Params

Create a Real-Time Payments Transfer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RealTimePaymentsTransferCreateParams.Builder`	A builder for RealTimePaymentsTransferCreateParams.
`public final class`	`RealTimePaymentsTransferCreateParams.Body`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`amount()`	The transfer amount in USD cents.
`final String`	`creditorName()`	The name of the transfer's recipient.
`final String`	`sourceAccountNumberId()`	The identifier of the Account Number from which to send the transfer.
`final String`	`unstructuredRemittanceInformation()`	Unstructured information that will show on the recipient's bank statement.
`final Optional<String>`	`accountNumber()`	The destination account number.
`final Optional<String>`	`debtorName()`	The name of the transfer's sender.
`final Optional<String>`	`externalAccountId()`	The ID of an External Account to initiate a transfer to.
`final Optional<Boolean>`	`requireApproval()`	Whether the transfer requires explicit approval via the dashboard or API.
`final Optional<String>`	`routingNumber()`	The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
`final Optional<String>`	`ultimateCreditorName()`	The name of the ultimate recipient of the transfer.
`final Optional<String>`	`ultimateDebtorName()`	The name of the ultimate sender of the transfer.
`final JsonField<Long>`	`_amount()`	Returns the raw JSON value of amount.
`final JsonField<String>`	`_creditorName()`	Returns the raw JSON value of creditorName.
`final JsonField<String>`	`_sourceAccountNumberId()`	Returns the raw JSON value of sourceAccountNumberId.
`final JsonField<String>`	`_unstructuredRemittanceInformation()`	Returns the raw JSON value of unstructuredRemittanceInformation.
`final JsonField<String>`	`_accountNumber()`	Returns the raw JSON value of accountNumber.
`final JsonField<String>`	`_debtorName()`	Returns the raw JSON value of debtorName.
`final JsonField<String>`	`_externalAccountId()`	Returns the raw JSON value of externalAccountId.
`final JsonField<Boolean>`	`_requireApproval()`	Returns the raw JSON value of requireApproval.
`final JsonField<String>`	`_routingNumber()`	Returns the raw JSON value of routingNumber.
`final JsonField<String>`	`_ultimateCreditorName()`	Returns the raw JSON value of ultimateCreditorName.
`final JsonField<String>`	`_ultimateDebtorName()`	Returns the raw JSON value of ultimateDebtorName.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final RealTimePaymentsTransferCreateParams.Builder`	`toBuilder()`
`final RealTimePaymentsTransferCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RealTimePaymentsTransferCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RealTimePaymentsTransferCreateParams.

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

- Constructor Detail
- Method Detail
  - amount
```
 final Long amount()
```
    The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.
  - creditorName
```
 final String creditorName()
```
    The name of the transfer's recipient.
  - sourceAccountNumberId
```
 final String sourceAccountNumberId()
```
    The identifier of the Account Number from which to send the transfer.
  - unstructuredRemittanceInformation
```
 final String unstructuredRemittanceInformation()
```
    Unstructured information that will show on the recipient's bank statement.
  - accountNumber
```
 final Optional<String> accountNumber()
```
    The destination account number.
  - debtorName
```
 final Optional<String> debtorName()
```
    The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
  - externalAccountId
```
 final Optional<String> externalAccountId()
```
    The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number and routing_number must be absent.
  - requireApproval
```
 final Optional<Boolean> requireApproval()
```
    Whether the transfer requires explicit approval via the dashboard or API.
  - routingNumber
```
 final Optional<String> routingNumber()
```
    The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
  - ultimateCreditorName
```
 final Optional<String> ultimateCreditorName()
```
    The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.
  - ultimateDebtorName
```
 final Optional<String> ultimateDebtorName()
```
    The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.
  - _amount
```
 final JsonField<Long> _amount()
```
    Returns the raw JSON value of amount.
    Unlike amount, this method doesn't throw if the JSON field has an unexpected type.
  - _creditorName
```
 final JsonField<String> _creditorName()
```
    Returns the raw JSON value of creditorName.
    Unlike creditorName, this method doesn't throw if the JSON field has an unexpected type.
  - _sourceAccountNumberId
```
 final JsonField<String> _sourceAccountNumberId()
```
    Returns the raw JSON value of sourceAccountNumberId.
    Unlike sourceAccountNumberId, this method doesn't throw if the JSON field has an unexpected type.
  - _unstructuredRemittanceInformation
```
 final JsonField<String> _unstructuredRemittanceInformation()
```
    Returns the raw JSON value of unstructuredRemittanceInformation.
    Unlike unstructuredRemittanceInformation, this method doesn't throw if the JSON field has an unexpected type.
  - _accountNumber
```
 final JsonField<String> _accountNumber()
```
    Returns the raw JSON value of accountNumber.
    Unlike accountNumber, this method doesn't throw if the JSON field has an unexpected type.
  - _debtorName
```
 final JsonField<String> _debtorName()
```
    Returns the raw JSON value of debtorName.
    Unlike debtorName, this method doesn't throw if the JSON field has an unexpected type.
  - _externalAccountId
```
 final JsonField<String> _externalAccountId()
```
    Returns the raw JSON value of externalAccountId.
    Unlike externalAccountId, this method doesn't throw if the JSON field has an unexpected type.
  - _requireApproval
```
 final JsonField<Boolean> _requireApproval()
```
    Returns the raw JSON value of requireApproval.
    Unlike requireApproval, this method doesn't throw if the JSON field has an unexpected type.
  - _routingNumber
```
 final JsonField<String> _routingNumber()
```
    Returns the raw JSON value of routingNumber.
    Unlike routingNumber, this method doesn't throw if the JSON field has an unexpected type.
  - _ultimateCreditorName
```
 final JsonField<String> _ultimateCreditorName()
```
    Returns the raw JSON value of ultimateCreditorName.
    Unlike ultimateCreditorName, this method doesn't throw if the JSON field has an unexpected type.
  - _ultimateDebtorName
```
 final JsonField<String> _ultimateDebtorName()
```
    Returns the raw JSON value of ultimateDebtorName.
    Unlike ultimateDebtorName, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final RealTimePaymentsTransferCreateParams.Builder toBuilder()
```
  - _body
```
 final RealTimePaymentsTransferCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RealTimePaymentsTransferCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of RealTimePaymentsTransferCreateParams.
    The following fields are required:
    .amount() .creditorName() .sourceAccountNumberId() .unstructuredRemittanceInformation()

Class RealTimePaymentsTransferCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

amount

creditorName

sourceAccountNumberId

unstructuredRemittanceInformation

accountNumber

debtorName

externalAccountId

requireApproval

routingNumber

ultimateCreditorName

ultimateDebtorName

_amount

_creditorName

_sourceAccountNumberId

_unstructuredRemittanceInformation

_accountNumber

_debtorName

_externalAccountId

_requireApproval

_routingNumber

_ultimateCreditorName

_ultimateDebtorName

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder