Increase.WireTransfers.WireTransfer (Increase v1.0.0)

Copy Markdown View Source

Wire transfers move funds between your Increase account and any other account accessible by Fedwire.

Fields

  • id - The wire transfer's identifier.
  • account_id - The Account to which the transfer belongs.
  • account_number - The destination account number.
  • amount - The transfer amount in USD cents.
  • 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.
  • 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 - The person or business that is receiving the funds from the transfer.
  • currency - The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.
  • debtor - The person or business whose funds are being transferred.
  • 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.
  • inbound_wire_drawdown_request_id - The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.
  • network - The transfer's network.
  • 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.
  • remittance - Remittance information sent with the wire transfer.
  • reversal - If your transfer is reversed, this will contain details of the reversal.
  • routing_number - The American Bankers' Association (ABA) Routing Transit Number (RTN).
  • source_account_number_id - The Account Number that was passed to the wire's recipient.
  • status - The lifecycle status of the transfer.
  • submission - After the transfer is submitted to Fedwire, this will contain supplemental details.
  • 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 wire_transfer.
  • unique_end_to_end_transaction_reference - The unique end-to-end transaction reference (UETR) of the transfer.

Summary

Types

t()

@type t() :: %Increase.WireTransfers.WireTransfer{
  account_id: String.t(),
  account_number: String.t(),
  amount: integer(),
  approval: Increase.WireTransfers.WireTransfer.Approval.t() | nil,
  cancellation: Increase.WireTransfers.WireTransfer.Cancellation.t() | nil,
  created_at: DateTime.t(),
  created_by: Increase.WireTransfers.WireTransfer.CreatedBy.t() | nil,
  creditor: Increase.WireTransfers.WireTransfer.Creditor.t() | nil,
  currency: String.t(),
  debtor: Increase.WireTransfers.WireTransfer.Debtor.t() | nil,
  external_account_id: String.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  inbound_wire_drawdown_request_id: String.t() | nil,
  network: String.t(),
  pending_transaction_id: String.t() | nil,
  remittance: Increase.WireTransfers.WireTransfer.Remittance.t() | nil,
  reversal: Increase.WireTransfers.WireTransfer.Reversal.t() | nil,
  routing_number: String.t(),
  source_account_number_id: String.t() | nil,
  status: String.t(),
  submission: Increase.WireTransfers.WireTransfer.Submission.t() | nil,
  transaction_id: String.t() | nil,
  type: String.t(),
  unique_end_to_end_transaction_reference: String.t() | nil
}