Increase.PendingTransactions.PendingTransaction (Increase v1.0.0)

Copy Markdown View Source

Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers].

Fields

  • id - The Pending Transaction identifier.

  • account_id - The identifier for the account this Pending Transaction belongs to.

  • amount - The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

  • completed_at - The ISO 8601 date on which the Pending Transaction was completed.

  • created_at - The ISO 8601 date on which the Pending Transaction occurred.

  • currency - The ISO 4217 code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.

  • description - For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.

  • held_amount - The amount that this Pending Transaction decrements the available balance of its Account. This is usually the same as amount, but will differ if the amount is positive.

  • route_id - The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.

  • route_type - The type of the route this Pending Transaction came through.

  • source - This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location. A map keyed by "category". Exactly one of the following keys is present, matching that discriminator's value:

    • "account_transfer_instruction"
    • "ach_transfer_instruction"
    • "blockchain_offramp_transfer"
    • "blockchain_onramp_transfer_instruction"
    • "card_authorization"
    • "card_push_transfer_instruction"
    • "check_deposit_instruction"
    • "check_transfer_instruction"
    • "fednow_transfer_instruction"
    • "inbound_funds_hold"
    • "inbound_wire_transfer_reversal"
    • "other"
    • "real_time_payments_transfer_instruction"
    • "swift_transfer_instruction"
    • "wire_transfer_instruction"

  • status - Whether the Pending Transaction has been confirmed and has an associated Transaction.

  • type - A constant representing the object's type. For this resource it will always be pending_transaction.

Summary

Types

t()

Types

t()

@type t() :: %Increase.PendingTransactions.PendingTransaction{
  account_id: String.t(),
  amount: integer(),
  completed_at: DateTime.t() | nil,
  created_at: DateTime.t(),
  currency: String.t(),
  description: String.t(),
  held_amount: integer(),
  id: String.t(),
  route_id: String.t() | nil,
  route_type: String.t() | nil,
  source: map(),
  status: String.t(),
  type: String.t()
}