Increase.ACHTransfers.ACHTransfer (Increase v1.0.0)

Copy Markdown View Source

ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).

Fields

  • id - The ACH transfer's identifier.
  • account_id - The Account to which the transfer belongs.
  • account_number - The destination account number.
  • acknowledgement - After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
  • addenda - Additional information that will be sent to the recipient.
  • amount - The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account.
  • approval - If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
  • cancellation - If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
  • company_descriptive_date - The description of the date of the transfer.
  • company_discretionary_data - The data you chose to associate with the transfer.
  • company_entry_description - The description of the transfer you set to be shown to the recipient.
  • company_id - The company ID associated with the transfer.
  • company_name - The name by which the recipient knows you.
  • created_at - The ISO 8601 date and time at which the transfer was created.
  • created_by - What object created the transfer, either via the API or the dashboard.
  • currency - The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd.
  • destination_account_holder - The type of entity that owns the account to which the ACH Transfer is being sent.
  • external_account_id - The identifier of the External Account the transfer was made to, if any.
  • funding - The type of the account to which the transfer will be sent.
  • idempotency_key - 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.
  • inbound_funds_hold - Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.
  • individual_id - Your identifier for the transfer recipient.
  • individual_name - The name of the transfer recipient. This value is informational and not verified by the recipient's bank.
  • network - The transfer's network.
  • notifications_of_change - If the receiving bank notifies that future transfers should use different details, this will contain those details.
  • pending_transaction_id - 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.
  • preferred_effective_date - 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.
  • return - If your transfer is returned, this will contain details of the return.
  • routing_number - The American Bankers' Association (ABA) Routing Transit Number (RTN).
  • settlement - A subhash containing information about when and how the transfer settled at the Federal Reserve.
  • standard_entry_class_code - The [Standard Entry Class (SEC) code]to use for the transfer.
  • statement_descriptor - The descriptor that will show on the recipient's bank statement.
  • status - The lifecycle status of the transfer.
  • submission - After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their posted schedule.
  • transaction_id - The ID for the transaction funding the transfer.
  • type - A constant representing the object's type. For this resource it will always be ach_transfer.

Summary

Types

t()

@type t() :: %Increase.ACHTransfers.ACHTransfer{
  account_id: String.t(),
  account_number: String.t(),
  acknowledgement: Increase.ACHTransfers.ACHTransfer.Acknowledgement.t() | nil,
  addenda: Increase.ACHTransfers.ACHTransfer.Addenda.t() | nil,
  amount: integer(),
  approval: Increase.ACHTransfers.ACHTransfer.Approval.t() | nil,
  cancellation: Increase.ACHTransfers.ACHTransfer.Cancellation.t() | nil,
  company_descriptive_date: String.t() | nil,
  company_discretionary_data: String.t() | nil,
  company_entry_description: String.t() | nil,
  company_id: String.t(),
  company_name: String.t() | nil,
  created_at: DateTime.t(),
  created_by: Increase.ACHTransfers.ACHTransfer.CreatedBy.t() | nil,
  currency: String.t(),
  destination_account_holder: String.t(),
  external_account_id: String.t() | nil,
  funding: String.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  inbound_funds_hold:
    Increase.ACHTransfers.ACHTransfer.InboundFundsHold.t() | nil,
  individual_id: String.t() | nil,
  individual_name: String.t() | nil,
  network: String.t(),
  notifications_of_change: [
    Increase.ACHTransfers.ACHTransfer.NotificationsOfChange.t()
  ],
  pending_transaction_id: String.t() | nil,
  preferred_effective_date:
    Increase.ACHTransfers.ACHTransfer.PreferredEffectiveDate.t(),
  return: Increase.ACHTransfers.ACHTransfer.Return.t() | nil,
  routing_number: String.t(),
  settlement: Increase.ACHTransfers.ACHTransfer.Settlement.t() | nil,
  standard_entry_class_code: String.t(),
  statement_descriptor: String.t(),
  status: String.t(),
  submission: Increase.ACHTransfers.ACHTransfer.Submission.t() | nil,
  transaction_id: String.t() | nil,
  type: String.t()
}