All Implemented Interfaces:
```
public final class RealTimePaymentsTransfer

                    
```
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RealTimePaymentsTransfer.Builder`	A builder for RealTimePaymentsTransfer.
`public final class`	`RealTimePaymentsTransfer.Acknowledgement`	If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
`public final class`	`RealTimePaymentsTransfer.Approval`	If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
`public final class`	`RealTimePaymentsTransfer.Cancellation`	If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
`public final class`	`RealTimePaymentsTransfer.CreatedBy`	What object created the transfer, either via the API or the dashboard.
`public final class`	`RealTimePaymentsTransfer.Currency`	The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.
`public final class`	`RealTimePaymentsTransfer.Rejection`	If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
`public final class`	`RealTimePaymentsTransfer.Status`	The lifecycle status of the transfer.
`public final class`	`RealTimePaymentsTransfer.Submission`	After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
`public final class`	`RealTimePaymentsTransfer.Type`	A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.

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 String`	`id()`	The Real-Time Payments Transfer's identifier.
`final String`	`accountId()`	The Account from which the transfer was sent.
`final Optional<RealTimePaymentsTransfer.Acknowledgement>`	`acknowledgement()`	If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
`final Long`	`amount()`	The transfer amount in USD cents.
`final Optional<RealTimePaymentsTransfer.Approval>`	`approval()`	If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
`final Optional<RealTimePaymentsTransfer.Cancellation>`	`cancellation()`	If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
`final OffsetDateTime`	`createdAt()`	The ISO 8601 date and time at which the transfer was created.
`final Optional<RealTimePaymentsTransfer.CreatedBy>`	`createdBy()`	What object created the transfer, either via the API or the dashboard.
`final String`	`creditorName()`	The name of the transfer's recipient.
`final RealTimePaymentsTransfer.Currency`	`currency()`	The ISO 4217 code for the transfer's currency.
`final Optional<String>`	`debtorName()`	The name of the transfer's sender.
`final String`	`destinationAccountNumber()`	The destination account number.
`final String`	`destinationRoutingNumber()`	The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
`final Optional<String>`	`externalAccountId()`	The identifier of the External Account the transfer was made to, if any.
`final Optional<String>`	`idempotencyKey()`	The idempotency key you chose for this object.
`final Optional<String>`	`pendingTransactionId()`	The ID for the pending transaction representing the transfer.
`final Optional<RealTimePaymentsTransfer.Rejection>`	`rejection()`	If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
`final String`	`remittanceInformation()`	Unstructured information that will show on the recipient's bank statement.
`final String`	`sourceAccountNumberId()`	The Account Number the recipient will see as having sent the transfer.
`final RealTimePaymentsTransfer.Status`	`status()`	The lifecycle status of the transfer.
`final Optional<RealTimePaymentsTransfer.Submission>`	`submission()`	After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
`final Optional<String>`	`transactionId()`	The Transaction funding the transfer once it is complete.
`final RealTimePaymentsTransfer.Type`	`type()`	A constant representing the object's type.
`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<String>`	`_id()`	The Real-Time Payments Transfer's identifier.
`final JsonField<String>`	`_accountId()`	The Account from which the transfer was sent.
`final JsonField<RealTimePaymentsTransfer.Acknowledgement>`	`_acknowledgement()`	If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
`final JsonField<Long>`	`_amount()`	The transfer amount in USD cents.
`final JsonField<RealTimePaymentsTransfer.Approval>`	`_approval()`	If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
`final JsonField<RealTimePaymentsTransfer.Cancellation>`	`_cancellation()`	If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
`final JsonField<OffsetDateTime>`	`_createdAt()`	The ISO 8601 date and time at which the transfer was created.
`final JsonField<RealTimePaymentsTransfer.CreatedBy>`	`_createdBy()`	What object created the transfer, either via the API or the dashboard.
`final JsonField<String>`	`_creditorName()`	The name of the transfer's recipient.
`final JsonField<RealTimePaymentsTransfer.Currency>`	`_currency()`	The ISO 4217 code for the transfer's currency.
`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 identifier of the External Account the transfer was made to, if any.
`final JsonField<String>`	`_idempotencyKey()`	The idempotency key you chose for this object.
`final JsonField<String>`	`_pendingTransactionId()`	The ID for the pending transaction representing the transfer.
`final JsonField<RealTimePaymentsTransfer.Rejection>`	`_rejection()`	If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
`final JsonField<String>`	`_remittanceInformation()`	Unstructured information that will show on the recipient's bank statement.
`final JsonField<String>`	`_sourceAccountNumberId()`	The Account Number the recipient will see as having sent the transfer.
`final JsonField<RealTimePaymentsTransfer.Status>`	`_status()`	The lifecycle status of the transfer.
`final JsonField<RealTimePaymentsTransfer.Submission>`	`_submission()`	After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
`final JsonField<String>`	`_transactionId()`	The Transaction funding the transfer once it is complete.
`final JsonField<RealTimePaymentsTransfer.Type>`	`_type()`	A constant representing the object's type.
`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>`	`_additionalProperties()`
`final RealTimePaymentsTransfer`	`validate()`
`final RealTimePaymentsTransfer.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RealTimePaymentsTransfer.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The Real-Time Payments Transfer's identifier.
  - accountId
```
 final String accountId()
```
    The Account from which the transfer was sent.
  - acknowledgement
```
 final Optional<RealTimePaymentsTransfer.Acknowledgement> acknowledgement()
```
    If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
  - amount
```
 final Long amount()
```
    The transfer amount in USD cents.
  - approval
```
 final Optional<RealTimePaymentsTransfer.Approval> approval()
```
    If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
  - cancellation
```
 final Optional<RealTimePaymentsTransfer.Cancellation> cancellation()
```
    If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
  - createdAt
```
 final OffsetDateTime createdAt()
```
    The ISO 8601 date and time at which the transfer was created.
  - createdBy
```
 final Optional<RealTimePaymentsTransfer.CreatedBy> createdBy()
```
    What object created the transfer, either via the API or the dashboard.
  - creditorName
```
 final String creditorName()
```
    The name of the transfer's recipient. This is set by the sender when creating the transfer.
  - currency
```
 final RealTimePaymentsTransfer.Currency currency()
```
    The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.
  - 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 String destinationAccountNumber()
```
    The destination account number.
  - destinationRoutingNumber
```
 final String destinationRoutingNumber()
```
    The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
  - externalAccountId
```
 final Optional<String> externalAccountId()
```
    The identifier of the External Account the transfer was made to, if any.
  - idempotencyKey
```
 final Optional<String> idempotencyKey()
```
    The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  - pendingTransactionId
```
 final Optional<String> pendingTransactionId()
```
    The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
  - rejection
```
 final Optional<RealTimePaymentsTransfer.Rejection> rejection()
```
    If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
  - remittanceInformation
```
 final String remittanceInformation()
```
    Unstructured information that will show on the recipient's bank statement.
  - sourceAccountNumberId
```
 final String sourceAccountNumberId()
```
    The Account Number the recipient will see as having sent the transfer.
  - status
```
 final RealTimePaymentsTransfer.Status status()
```
    The lifecycle status of the transfer.
  - submission
```
 final Optional<RealTimePaymentsTransfer.Submission> submission()
```
    After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
  - transactionId
```
 final Optional<String> transactionId()
```
    The Transaction funding the transfer once it is complete.
  - type
```
 final RealTimePaymentsTransfer.Type type()
```
    A constant representing the object's type. For this resource it will always be real_time_payments_transfer.
  - 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.
  - _id
```
 final JsonField<String> _id()
```
    The Real-Time Payments Transfer's identifier.
  - _accountId
```
 final JsonField<String> _accountId()
```
    The Account from which the transfer was sent.
  - _acknowledgement
```
 final JsonField<RealTimePaymentsTransfer.Acknowledgement> _acknowledgement()
```
    If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
  - _amount
```
 final JsonField<Long> _amount()
```
    The transfer amount in USD cents.
  - _approval
```
 final JsonField<RealTimePaymentsTransfer.Approval> _approval()
```
    If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
  - _cancellation
```
 final JsonField<RealTimePaymentsTransfer.Cancellation> _cancellation()
```
    If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
  - _createdAt
```
 final JsonField<OffsetDateTime> _createdAt()
```
    The ISO 8601 date and time at which the transfer was created.
  - _createdBy
```
 final JsonField<RealTimePaymentsTransfer.CreatedBy> _createdBy()
```
    What object created the transfer, either via the API or the dashboard.
  - _creditorName
```
 final JsonField<String> _creditorName()
```
    The name of the transfer's recipient. This is set by the sender when creating the transfer.
  - _currency
```
 final JsonField<RealTimePaymentsTransfer.Currency> _currency()
```
    The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.
  - _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 identifier of the External Account the transfer was made to, if any.
  - _idempotencyKey
```
 final JsonField<String> _idempotencyKey()
```
    The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  - _pendingTransactionId
```
 final JsonField<String> _pendingTransactionId()
```
    The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
  - _rejection
```
 final JsonField<RealTimePaymentsTransfer.Rejection> _rejection()
```
    If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
  - _remittanceInformation
```
 final JsonField<String> _remittanceInformation()
```
    Unstructured information that will show on the recipient's bank statement.
  - _sourceAccountNumberId
```
 final JsonField<String> _sourceAccountNumberId()
```
    The Account Number the recipient will see as having sent the transfer.
  - _status
```
 final JsonField<RealTimePaymentsTransfer.Status> _status()
```
    The lifecycle status of the transfer.
  - _submission
```
 final JsonField<RealTimePaymentsTransfer.Submission> _submission()
```
    After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
  - _transactionId
```
 final JsonField<String> _transactionId()
```
    The Transaction funding the transfer once it is complete.
  - _type
```
 final JsonField<RealTimePaymentsTransfer.Type> _type()
```
    A constant representing the object's type. For this resource it will always be real_time_payments_transfer.
  - _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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final RealTimePaymentsTransfer validate()
```
  - toBuilder
```
 final RealTimePaymentsTransfer.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RealTimePaymentsTransfer.Builder builder()
```

Class RealTimePaymentsTransfer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

accountId

acknowledgement

amount

approval

cancellation

createdAt

createdBy

creditorName

currency

debtorName

destinationAccountNumber

destinationRoutingNumber

externalAccountId

idempotencyKey

pendingTransactionId

rejection

remittanceInformation

sourceAccountNumberId

status

submission

transactionId

type

ultimateCreditorName

ultimateDebtorName

_id

_accountId

_acknowledgement

_amount

_approval

_cancellation

_createdAt

_createdBy

_creditorName

_currency

_debtorName

_destinationAccountNumber

_destinationRoutingNumber

_externalAccountId

_idempotencyKey

_pendingTransactionId

_rejection

_remittanceInformation

_sourceAccountNumberId

_status

_submission

_transactionId

_type

_ultimateCreditorName

_ultimateDebtorName

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder