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.Body`
`public final class`	`RealTimePaymentsTransferCreateParams.Builder`	A builder for RealTimePaymentsTransferCreateParams.

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`	`remittanceInformation()`	Unstructured information that will show on the recipient's bank statement.
`final String`	`sourceAccountNumberId()`	The identifier of the Account Number from which to send the transfer.
`final Optional<String>`	`debtorName()`	The name of the transfer's sender.
`final Optional<String>`	`destinationAccountNumber()`	The destination account number.
`final Optional<String>`	`destinationRoutingNumber()`	The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
`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>`	`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()`	The transfer amount in USD cents.
`final JsonField<String>`	`_creditorName()`	The name of the transfer's recipient.
`final JsonField<String>`	`_remittanceInformation()`	Unstructured information that will show on the recipient's bank statement.
`final JsonField<String>`	`_sourceAccountNumberId()`	The identifier of the Account Number from which to send the transfer.
`final JsonField<String>`	`_debtorName()`	The name of the transfer's sender.
`final JsonField<String>`	`_destinationAccountNumber()`	The destination account number.
`final JsonField<String>`	`_destinationRoutingNumber()`	The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
`final JsonField<String>`	`_externalAccountId()`	The ID of an External Account to initiate a transfer to.
`final JsonField<Boolean>`	`_requireApproval()`	Whether the transfer requires explicit approval via the dashboard or API.
`final JsonField<String>`	`_ultimateCreditorName()`	The name of the ultimate recipient of the transfer.
`final JsonField<String>`	`_ultimateDebtorName()`	The name of the ultimate sender of the transfer.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`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.
`final RealTimePaymentsTransferCreateParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RealTimePaymentsTransferCreateParams.Builder`	`builder()`

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.
  - remittanceInformation
```
 final String remittanceInformation()
```
    Unstructured information that will show on the recipient's bank statement.
  - sourceAccountNumberId
```
 final String sourceAccountNumberId()
```
    The identifier of the Account Number from which to send the transfer.
  - debtorName
```
 final Optional<String> debtorName()
```
    The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
  - destinationAccountNumber
```
 final Optional<String> destinationAccountNumber()
```
    The destination account number.
  - destinationRoutingNumber
```
 final Optional<String> destinationRoutingNumber()
```
    The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
  - externalAccountId
```
 final Optional<String> externalAccountId()
```
    The ID of an External Account to initiate a transfer to. If this parameter is provided, destination_account_number and destination_routing_number must be absent.
  - requireApproval
```
 final Optional<Boolean> requireApproval()
```
    Whether the transfer requires explicit approval via the dashboard or API.
  - 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()
```
    The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.
  - _creditorName
```
 final JsonField<String> _creditorName()
```
    The name of the transfer's recipient.
  - _remittanceInformation
```
 final JsonField<String> _remittanceInformation()
```
    Unstructured information that will show on the recipient's bank statement.
  - _sourceAccountNumberId
```
 final JsonField<String> _sourceAccountNumberId()
```
    The identifier of the Account Number from which to send the transfer.
  - _debtorName
```
 final JsonField<String> _debtorName()
```
    The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
  - _destinationAccountNumber
```
 final JsonField<String> _destinationAccountNumber()
```
    The destination account number.
  - _destinationRoutingNumber
```
 final JsonField<String> _destinationRoutingNumber()
```
    The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
  - _externalAccountId
```
 final JsonField<String> _externalAccountId()
```
    The ID of an External Account to initiate a transfer to. If this parameter is provided, destination_account_number and destination_routing_number must be absent.
  - _requireApproval
```
 final JsonField<Boolean> _requireApproval()
```
    Whether the transfer requires explicit approval via the dashboard or API.
  - _ultimateCreditorName
```
 final JsonField<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 JsonField<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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _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.
  - toBuilder
```
 final RealTimePaymentsTransferCreateParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RealTimePaymentsTransferCreateParams.Builder builder()
```

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

remittanceInformation

sourceAccountNumberId

debtorName

destinationAccountNumber

destinationRoutingNumber

externalAccountId

requireApproval

ultimateCreditorName

ultimateDebtorName

_amount

_creditorName

_remittanceInformation

_sourceAccountNumberId

_debtorName

_destinationAccountNumber

_destinationRoutingNumber

_externalAccountId

_requireApproval

_ultimateCreditorName

_ultimateDebtorName

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder