Constructor Detail

Method Detail

• accountId

   final AchTransferCreateParams.Body.Builder accountId(String accountId)

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

• accountId

   final AchTransferCreateParams.Body.Builder accountId(JsonField<String> accountId)

  Sets Builder.accountId to an arbitrary JSON value.

  You should usually call Builder.accountId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• amount

   final AchTransferCreateParams.Body.Builder amount(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.

• amount

   final AchTransferCreateParams.Body.Builder amount(JsonField<Long> amount)

  Sets Builder.amount to an arbitrary JSON value.

  You should usually call Builder.amount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• statementDescriptor

   final AchTransferCreateParams.Body.Builder statementDescriptor(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.

• statementDescriptor

   final AchTransferCreateParams.Body.Builder statementDescriptor(JsonField<String> statementDescriptor)

  Sets Builder.statementDescriptor to an arbitrary JSON value.

  You should usually call Builder.statementDescriptor with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• accountNumber

   final AchTransferCreateParams.Body.Builder accountNumber(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.

• accountNumber

   final AchTransferCreateParams.Body.Builder accountNumber(JsonField<String> accountNumber)

  Sets Builder.accountNumber to an arbitrary JSON value.

  You should usually call Builder.accountNumber with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addenda

   final AchTransferCreateParams.Body.Builder addenda(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.

• addenda

   final AchTransferCreateParams.Body.Builder addenda(JsonField<AchTransferCreateParams.Addenda> addenda)

  Sets Builder.addenda to an arbitrary JSON value.

  You should usually call Builder.addenda with a well-typed Addenda value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• companyDescriptiveDate

   final AchTransferCreateParams.Body.Builder companyDescriptiveDate(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.

• companyDescriptiveDate

   final AchTransferCreateParams.Body.Builder companyDescriptiveDate(JsonField<String> companyDescriptiveDate)

  Sets Builder.companyDescriptiveDate to an arbitrary JSON value.

  You should usually call Builder.companyDescriptiveDate with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• companyDiscretionaryData

   final AchTransferCreateParams.Body.Builder companyDiscretionaryData(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.

• companyDiscretionaryData

   final AchTransferCreateParams.Body.Builder companyDiscretionaryData(JsonField<String> companyDiscretionaryData)

  Sets Builder.companyDiscretionaryData to an arbitrary JSON value.

  You should usually call Builder.companyDiscretionaryData with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• companyEntryDescription

   final AchTransferCreateParams.Body.Builder companyEntryDescription(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.

• companyEntryDescription

   final AchTransferCreateParams.Body.Builder companyEntryDescription(JsonField<String> companyEntryDescription)

  Sets Builder.companyEntryDescription to an arbitrary JSON value.

  You should usually call Builder.companyEntryDescription with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• companyName

   final AchTransferCreateParams.Body.Builder companyName(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.

• companyName

   final AchTransferCreateParams.Body.Builder companyName(JsonField<String> companyName)

  Sets Builder.companyName to an arbitrary JSON value.

  You should usually call Builder.companyName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• destinationAccountHolder

   final AchTransferCreateParams.Body.Builder destinationAccountHolder(AchTransferCreateParams.DestinationAccountHolder destinationAccountHolder)

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

• destinationAccountHolder

   final AchTransferCreateParams.Body.Builder destinationAccountHolder(JsonField<AchTransferCreateParams.DestinationAccountHolder> destinationAccountHolder)

  Sets Builder.destinationAccountHolder to an arbitrary JSON value.

  You should usually call Builder.destinationAccountHolder with a well-typed DestinationAccountHolder value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• externalAccountId

   final AchTransferCreateParams.Body.Builder externalAccountId(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.

• externalAccountId

   final AchTransferCreateParams.Body.Builder externalAccountId(JsonField<String> externalAccountId)

  Sets Builder.externalAccountId to an arbitrary JSON value.

  You should usually call Builder.externalAccountId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• funding

   final AchTransferCreateParams.Body.Builder funding(AchTransferCreateParams.Funding funding)

  The type of the receiver's bank account.

• funding

   final AchTransferCreateParams.Body.Builder funding(JsonField<AchTransferCreateParams.Funding> funding)

  Sets Builder.funding to an arbitrary JSON value.

  You should usually call Builder.funding with a well-typed Funding value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• individualId

   final AchTransferCreateParams.Body.Builder individualId(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.

• individualId

   final AchTransferCreateParams.Body.Builder individualId(JsonField<String> individualId)

  Sets Builder.individualId to an arbitrary JSON value.

  You should usually call Builder.individualId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• individualName

   final AchTransferCreateParams.Body.Builder individualName(String individualName)

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

• individualName

   final AchTransferCreateParams.Body.Builder individualName(JsonField<String> individualName)

  Sets Builder.individualName to an arbitrary JSON value.

  You should usually call Builder.individualName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• preferredEffectiveDate

   final AchTransferCreateParams.Body.Builder preferredEffectiveDate(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.

• preferredEffectiveDate

   final AchTransferCreateParams.Body.Builder preferredEffectiveDate(JsonField<AchTransferCreateParams.PreferredEffectiveDate> preferredEffectiveDate)

  Sets Builder.preferredEffectiveDate to an arbitrary JSON value.

  You should usually call Builder.preferredEffectiveDate with a well-typed PreferredEffectiveDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• requireApproval

   final AchTransferCreateParams.Body.Builder requireApproval(Boolean requireApproval)

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

• requireApproval

   final AchTransferCreateParams.Body.Builder requireApproval(JsonField<Boolean> requireApproval)

  Sets Builder.requireApproval to an arbitrary JSON value.

  You should usually call Builder.requireApproval with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• routingNumber

   final AchTransferCreateParams.Body.Builder routingNumber(String routingNumber)

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

• routingNumber

   final AchTransferCreateParams.Body.Builder routingNumber(JsonField<String> routingNumber)

  Sets Builder.routingNumber to an arbitrary JSON value.

  You should usually call Builder.routingNumber with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• standardEntryClassCode

   final AchTransferCreateParams.Body.Builder standardEntryClassCode(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.

• standardEntryClassCode

   final AchTransferCreateParams.Body.Builder standardEntryClassCode(JsonField<AchTransferCreateParams.StandardEntryClassCode> standardEntryClassCode)

  Sets Builder.standardEntryClassCode to an arbitrary JSON value.

  You should usually call Builder.standardEntryClassCode with a well-typed StandardEntryClassCode value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• transactionTiming

   final AchTransferCreateParams.Body.Builder transactionTiming(AchTransferCreateParams.TransactionTiming transactionTiming)

  The timing of the transaction.

• transactionTiming

   final AchTransferCreateParams.Body.Builder transactionTiming(JsonField<AchTransferCreateParams.TransactionTiming> transactionTiming)

  Sets Builder.transactionTiming to an arbitrary JSON value.

  You should usually call Builder.transactionTiming with a well-typed TransactionTiming value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final AchTransferCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final AchTransferCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final AchTransferCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final AchTransferCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final AchTransferCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final AchTransferCreateParams.Body build()

  Returns an immutable instance of Body.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

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