Constructor Detail

Method Detail

• body

   final AchTransferCreateParams.Builder body(AchTransferCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • accountId

  • amount

  • statementDescriptor

  • accountNumber

  • addenda

  • etc.

• accountId

   final AchTransferCreateParams.Builder accountId(String accountId)

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

• accountId

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

  The account number for the destination account.

• accountNumber

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

  Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.

• addenda

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

  The description of the date of the transfer, usually in the format YYMMDD. This is included in the transfer data sent to the receiving bank.

• companyDescriptiveDate

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

  The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.

• companyDiscretionaryData

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

  A description of the transfer, included in the transfer data sent to the receiving bank. Standardized formatting may be required, for example PAYROLL for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.

• companyEntryDescription

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

  The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.

• companyName

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

  The type of entity that owns the account to which the ACH Transfer is being sent.

• destinationAccountHolder

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

  The type of the account to which the transfer will be sent.

• funding

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

  Your identifier for the transfer recipient.

• individualId

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

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

• requireApproval

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

  The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

• routingNumber

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

  The /documentation/ach-standard-entry-class-codes to use for the transfer.

• standardEntryClassCode

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

  The timing of the transaction.

• transactionTiming

   final AchTransferCreateParams.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.

• additionalBodyProperties

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

• putAdditionalBodyProperty

   final AchTransferCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final AchTransferCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final AchTransferCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final AchTransferCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final AchTransferCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final AchTransferCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final AchTransferCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final AchTransferCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final AchTransferCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final AchTransferCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final AchTransferCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final AchTransferCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final AchTransferCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final AchTransferCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final AchTransferCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final AchTransferCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final AchTransferCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final AchTransferCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final AchTransferCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final AchTransferCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final AchTransferCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final AchTransferCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final AchTransferCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final AchTransferCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final AchTransferCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final AchTransferCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final AchTransferCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final AchTransferCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final AchTransferCreateParams build()

  Returns an immutable instance of AchTransferCreateParams.

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

  The following fields are required:

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