Constructor Detail

Method Detail

• body

   final RealTimePaymentsTransferCreateParams.Builder body(RealTimePaymentsTransferCreateParams.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:

  • amount

  • creditorName

  • remittanceInformation

  • sourceAccountNumberId

  • debtorName

  • etc.

• amount

   final RealTimePaymentsTransferCreateParams.Builder amount(Long amount)

  The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.

• amount

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

• creditorName

   final RealTimePaymentsTransferCreateParams.Builder creditorName(String creditorName)

  The name of the transfer's recipient.

• creditorName

   final RealTimePaymentsTransferCreateParams.Builder creditorName(JsonField<String> creditorName)

  Sets Builder.creditorName to an arbitrary JSON value.

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

• remittanceInformation

   final RealTimePaymentsTransferCreateParams.Builder remittanceInformation(String remittanceInformation)

  Unstructured information that will show on the recipient's bank statement.

• remittanceInformation

   final RealTimePaymentsTransferCreateParams.Builder remittanceInformation(JsonField<String> remittanceInformation)

  Sets Builder.remittanceInformation to an arbitrary JSON value.

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

• sourceAccountNumberId

   final RealTimePaymentsTransferCreateParams.Builder sourceAccountNumberId(String sourceAccountNumberId)

  The identifier of the Account Number from which to send the transfer.

• sourceAccountNumberId

   final RealTimePaymentsTransferCreateParams.Builder sourceAccountNumberId(JsonField<String> sourceAccountNumberId)

  Sets Builder.sourceAccountNumberId to an arbitrary JSON value.

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

• debtorName

   final RealTimePaymentsTransferCreateParams.Builder debtorName(String debtorName)

  The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

• debtorName

   final RealTimePaymentsTransferCreateParams.Builder debtorName(JsonField<String> debtorName)

  Sets Builder.debtorName to an arbitrary JSON value.

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

• destinationAccountNumber

   final RealTimePaymentsTransferCreateParams.Builder destinationAccountNumber(String destinationAccountNumber)

  The destination account number.

• destinationAccountNumber

   final RealTimePaymentsTransferCreateParams.Builder destinationAccountNumber(JsonField<String> destinationAccountNumber)

  Sets Builder.destinationAccountNumber to an arbitrary JSON value.

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

• destinationRoutingNumber

   final RealTimePaymentsTransferCreateParams.Builder destinationRoutingNumber(String destinationRoutingNumber)

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

• destinationRoutingNumber

   final RealTimePaymentsTransferCreateParams.Builder destinationRoutingNumber(JsonField<String> destinationRoutingNumber)

  Sets Builder.destinationRoutingNumber to an arbitrary JSON value.

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

• externalAccountId

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

• externalAccountId

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

• requireApproval

   final RealTimePaymentsTransferCreateParams.Builder requireApproval(Boolean requireApproval)

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

• requireApproval

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

• ultimateCreditorName

   final RealTimePaymentsTransferCreateParams.Builder ultimateCreditorName(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.

• ultimateCreditorName

   final RealTimePaymentsTransferCreateParams.Builder ultimateCreditorName(JsonField<String> ultimateCreditorName)

  Sets Builder.ultimateCreditorName to an arbitrary JSON value.

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

• ultimateDebtorName

   final RealTimePaymentsTransferCreateParams.Builder ultimateDebtorName(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.

• ultimateDebtorName

   final RealTimePaymentsTransferCreateParams.Builder ultimateDebtorName(JsonField<String> ultimateDebtorName)

  Sets Builder.ultimateDebtorName to an arbitrary JSON value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final RealTimePaymentsTransferCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final RealTimePaymentsTransferCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final RealTimePaymentsTransferCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final RealTimePaymentsTransferCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final RealTimePaymentsTransferCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final RealTimePaymentsTransferCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final RealTimePaymentsTransferCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final RealTimePaymentsTransferCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final RealTimePaymentsTransferCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final RealTimePaymentsTransferCreateParams build()

  Returns an immutable instance of RealTimePaymentsTransferCreateParams.

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

  The following fields are required:

  .amount()
  .creditorName()
  .remittanceInformation()
  .sourceAccountNumberId()