Increase.InboundCheckDeposits.InboundCheckDeposit (Increase v1.0.0)

Copy Markdown View Source

Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.

Fields

  • id - The deposit's identifier.
  • accepted_at - If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.
  • account_id - The Account the check is being deposited against.
  • account_number_id - The Account Number the check is being deposited against.
  • adjustments - If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.
  • amount - The deposited amount in USD cents.
  • back_image_file_id - The ID for the File containing the image of the back of the check.
  • bank_of_first_deposit_routing_number - The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.
  • check_number - The check number printed on the check being deposited.
  • check_transfer_id - If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.
  • created_at - The ISO 8601 date and time at which the deposit was attempted.
  • currency - The ISO 4217 code for the deposit.
  • declined_at - If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.
  • declined_transaction_id - If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.
  • deposit_return - If you requested a return of this deposit, this will contain details of the return.
  • front_image_file_id - The ID for the File containing the image of the front of the check.
  • payee_name_analysis - Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.
  • status - The status of the Inbound Check Deposit.
  • transaction_id - If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.
  • type - A constant representing the object's type. For this resource it will always be inbound_check_deposit.

Summary

Types

t()

Types

t()

@type t() :: %Increase.InboundCheckDeposits.InboundCheckDeposit{
  accepted_at: DateTime.t() | nil,
  account_id: String.t(),
  account_number_id: String.t() | nil,
  adjustments: [
    Increase.InboundCheckDeposits.InboundCheckDeposit.Adjustment.t()
  ],
  amount: integer(),
  back_image_file_id: String.t() | nil,
  bank_of_first_deposit_routing_number: String.t() | nil,
  check_number: String.t() | nil,
  check_transfer_id: String.t() | nil,
  created_at: DateTime.t(),
  currency: String.t(),
  declined_at: DateTime.t() | nil,
  declined_transaction_id: String.t() | nil,
  deposit_return:
    Increase.InboundCheckDeposits.InboundCheckDeposit.DepositReturn.t() | nil,
  front_image_file_id: String.t() | nil,
  id: String.t(),
  payee_name_analysis: String.t(),
  status: String.t(),
  transaction_id: String.t() | nil,
  type: String.t()
}