Increase.CheckDeposits.CheckDeposit.InboundFundsHold (Increase v1.0.0)

Copy Markdown View Source

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

Fields

  • amount - The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.
  • automatically_releases_at - When the hold will be released automatically. Certain conditions may cause it to be released before this time.
  • created_at - The ISO 8601 time at which the hold was created.
  • currency - The ISO 4217 code for the hold's currency.
  • held_transaction_id - The ID of the Transaction for which funds were held.
  • pending_transaction_id - The ID of the Pending Transaction representing the held funds.
  • released_at - When the hold was released (if it has been released).
  • status - The status of the hold.
  • type - A constant representing the object's type. For this resource it will always be inbound_funds_hold.

Summary

Types

t()

Types

t()

@type t() :: %Increase.CheckDeposits.CheckDeposit.InboundFundsHold{
  amount: integer(),
  automatically_releases_at: DateTime.t(),
  created_at: DateTime.t(),
  currency: String.t(),
  held_transaction_id: String.t() | nil,
  pending_transaction_id: String.t() | nil,
  released_at: DateTime.t() | nil,
  status: String.t(),
  type: String.t()
}