Constructor Detail

Method Detail

• accountId

   final String accountId()

  The Increase identifier for the account that will send the transfer.

• amount

   final Long amount()

  The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

• statementDescriptor

   final String statementDescriptor()

  A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If individual_name and company_name are not explicitly set by this API, the statement_descriptor will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass individual_name and company_name instead of relying on this fallback.

• accountNumber

   final Optional<String> accountNumber()

  The receiver's account number. For credit transfers (positive amount) this is the account that funds will be sent to. For debit transfers (negative amount) this is the account that funds will be pulled from.

• addenda

   final Optional<AchTransferCreateParams.Addenda> addenda()

  Additional information passed through to the receiving bank with the transfer. Most ACH transfers do not need this. Only set this if your recipient has asked for addendum data, typically unstructured remittance information. Corporate Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.

• companyDescriptiveDate

   final Optional<String> companyDescriptiveDate()

  A description of the transfer date (typically YYMMDD), sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Only set this if your recipient has asked for it.

• companyDiscretionaryData

   final Optional<String> companyDiscretionaryData()

  Custom data sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Most ACH transfers do not need this. Only set this if your recipient has asked for it.

• companyEntryDescription

   final Optional<String> companyEntryDescription()

  A short description sent in the company batch header. Most receivers do not surface this. Only set this if your recipient has asked for a specific value or if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For example, Prearranged Payment and Deposit (PPD) payroll credits must use PAYROLL, and reversals must use REVERSAL.

• companyName

   final Optional<String> companyName()

  The name by which the recipient knows you, sent in the company batch header. We recommend setting this on every transfer; if you do not, we fall back to the ACH company name configured on your account.

• destinationAccountHolder

   final Optional<AchTransferCreateParams.DestinationAccountHolder> destinationAccountHolder()

  The type of entity that owns the receiver's account.

• externalAccountId

   final Optional<String> externalAccountId()

  The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number, routing_number, and funding must be absent.

• funding

   final Optional<AchTransferCreateParams.Funding> funding()

  The type of the receiver's bank account.

• individualId

   final Optional<String> individualId()

  Your internal identifier for the transfer recipient. This value is informational and not verified by the recipient's bank. Most callers can leave this unset.

• individualName

   final Optional<String> individualName()

  The name of the transfer recipient. This value is informational and not verified by the recipient's bank.

• preferredEffectiveDate

   final Optional<AchTransferCreateParams.PreferredEffectiveDate> preferredEffectiveDate()

  Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule of same_day. If set, exactly one of the child attributes must be set.

• requireApproval

   final Optional<Boolean> requireApproval()

  Whether the transfer requires explicit approval via the dashboard or API.

• routingNumber

   final Optional<String> routingNumber()

  The American Bankers' Association (ABA) Routing Transit Number (RTN) of the receiver's bank.

• standardEntryClassCode

   final Optional<AchTransferCreateParams.StandardEntryClassCode> standardEntryClassCode()

  The /documentation/ach-standard-entry-class-codes to use for the transfer. If not provided, the default is corporate_credit_or_debit.

• transactionTiming

   final Optional<AchTransferCreateParams.TransactionTiming> transactionTiming()

  The timing of the transaction.

• _accountId

   final JsonField<String> _accountId()

  Returns the raw JSON value of accountId.

  Unlike accountId, this method doesn't throw if the JSON field has an unexpected type.

• _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.

• _statementDescriptor

   final JsonField<String> _statementDescriptor()

  Returns the raw JSON value of statementDescriptor.

  Unlike statementDescriptor, 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.

• _addenda

   final JsonField<AchTransferCreateParams.Addenda> _addenda()

  Returns the raw JSON value of addenda.

  Unlike addenda, this method doesn't throw if the JSON field has an unexpected type.

• _companyDescriptiveDate

   final JsonField<String> _companyDescriptiveDate()

  Returns the raw JSON value of companyDescriptiveDate.

  Unlike companyDescriptiveDate, this method doesn't throw if the JSON field has an unexpected type.

• _companyDiscretionaryData

   final JsonField<String> _companyDiscretionaryData()

  Returns the raw JSON value of companyDiscretionaryData.

  Unlike companyDiscretionaryData, this method doesn't throw if the JSON field has an unexpected type.

• _companyEntryDescription

   final JsonField<String> _companyEntryDescription()

  Returns the raw JSON value of companyEntryDescription.

  Unlike companyEntryDescription, this method doesn't throw if the JSON field has an unexpected type.

• _companyName

   final JsonField<String> _companyName()

  Returns the raw JSON value of companyName.

  Unlike companyName, this method doesn't throw if the JSON field has an unexpected type.

• _destinationAccountHolder

   final JsonField<AchTransferCreateParams.DestinationAccountHolder> _destinationAccountHolder()

  Returns the raw JSON value of destinationAccountHolder.

  Unlike destinationAccountHolder, 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.

• _funding

   final JsonField<AchTransferCreateParams.Funding> _funding()

  Returns the raw JSON value of funding.

  Unlike funding, this method doesn't throw if the JSON field has an unexpected type.

• _individualId

   final JsonField<String> _individualId()

  Returns the raw JSON value of individualId.

  Unlike individualId, this method doesn't throw if the JSON field has an unexpected type.

• _individualName

   final JsonField<String> _individualName()

  Returns the raw JSON value of individualName.

  Unlike individualName, this method doesn't throw if the JSON field has an unexpected type.

• _preferredEffectiveDate

   final JsonField<AchTransferCreateParams.PreferredEffectiveDate> _preferredEffectiveDate()

  Returns the raw JSON value of preferredEffectiveDate.

  Unlike preferredEffectiveDate, 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.

• _standardEntryClassCode

   final JsonField<AchTransferCreateParams.StandardEntryClassCode> _standardEntryClassCode()

  Returns the raw JSON value of standardEntryClassCode.

  Unlike standardEntryClassCode, this method doesn't throw if the JSON field has an unexpected type.

• _transactionTiming

   final JsonField<AchTransferCreateParams.TransactionTiming> _transactionTiming()

  Returns the raw JSON value of transactionTiming.

  Unlike transactionTiming, 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 AchTransferCreateParams.Builder toBuilder()

• _body

   final AchTransferCreateParams.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 AchTransferCreateParams.Builder builder()

  Returns a mutable builder for constructing an instance of AchTransferCreateParams.

  The following fields are required:

  .accountId()
  .amount()
  .statementDescriptor()