Increase.FednowTransfers.FednowTransfer (Increase v1.0.0)

Copy Markdown View Source

FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.

Fields

  • id - The FedNow Transfer's identifier.
  • account_id - The Account from which the transfer was sent.
  • account_number - The destination account number.
  • acknowledgement - If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
  • amount - The transfer amount in USD cents.
  • 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.
  • creditor_address - The creditor's address.
  • creditor_name - The name of the transfer's recipient. This is set by the sender when creating the transfer.
  • currency - The ISO 4217 code for the transfer's currency. For FedNow transfers this is always equal to USD.
  • debtor_address - The debtor's address.
  • debtor_name - The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
  • external_account_id - The identifier of the External Account the transfer was made to, if any.
  • 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.
  • pending_transaction_id - The ID for the pending transaction representing the transfer.
  • rejection - If the transfer is rejected by FedNow or the destination financial institution, this will contain supplemental details.
  • routing_number - The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
  • source_account_number_id - The Account Number the recipient will see as having sent the transfer.
  • status - The lifecycle status of the transfer.
  • submission - After the transfer is submitted to FedNow, this will contain supplemental details.
  • transaction_id - The Transaction funding the transfer once it is complete.
  • type - A constant representing the object's type. For this resource it will always be fednow_transfer.
  • unique_end_to_end_transaction_reference - The Unique End-to-end Transaction Reference (UETR) of the transfer.
  • unstructured_remittance_information - Unstructured information that will show on the recipient's bank statement.

Summary

Types

t()

Types

t()

@type t() :: %Increase.FednowTransfers.FednowTransfer{
  account_id: String.t(),
  account_number: String.t(),
  acknowledgement:
    Increase.FednowTransfers.FednowTransfer.Acknowledgement.t() | nil,
  amount: integer(),
  created_at: DateTime.t(),
  created_by: Increase.FednowTransfers.FednowTransfer.CreatedBy.t() | nil,
  creditor_address:
    Increase.FednowTransfers.FednowTransfer.CreditorAddress.t() | nil,
  creditor_name: String.t(),
  currency: String.t(),
  debtor_address:
    Increase.FednowTransfers.FednowTransfer.DebtorAddress.t() | nil,
  debtor_name: String.t(),
  external_account_id: String.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  pending_transaction_id: String.t() | nil,
  rejection: Increase.FednowTransfers.FednowTransfer.Rejection.t() | nil,
  routing_number: String.t(),
  source_account_number_id: String.t(),
  status: String.t(),
  submission: Increase.FednowTransfers.FednowTransfer.Submission.t() | nil,
  transaction_id: String.t() | nil,
  type: String.t(),
  unique_end_to_end_transaction_reference: String.t(),
  unstructured_remittance_information: String.t()
}