Increase.CheckDeposits.CheckDeposit (Increase v1.0.0)

Copy Markdown View Source

Check Deposits allow you to deposit images of paper checks into your account.

Fields

  • id - The deposit's identifier.
  • account_id - The Account the check was deposited into.
  • 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.
  • created_at - The ISO 8601 date and time at which the transfer was created.
  • deposit_acceptance - Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
  • deposit_adjustments - If the deposit or the return was adjusted by the receiving institution, this will contain details of the adjustments.
  • deposit_rejection - If your deposit is rejected by Increase, this will contain details as to why it was rejected.
  • deposit_return - If your deposit is returned, this will contain details as to why it was returned.
  • deposit_submission - After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.
  • description - The description of the Check Deposit, for display purposes only.
  • front_image_file_id - The ID for the File containing the image of the front of the check.
  • 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_funds_hold - Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.
  • inbound_mail_item_id - If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.
  • lockbox_recipient_id - If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it.
  • status - The status of the Check Deposit.
  • transaction_id - The ID for the Transaction created by the deposit.
  • type - A constant representing the object's type. For this resource it will always be check_deposit.

Summary

Types

t()

Types

t()

@type t() :: %Increase.CheckDeposits.CheckDeposit{
  account_id: String.t(),
  amount: integer(),
  back_image_file_id: String.t() | nil,
  created_at: DateTime.t(),
  deposit_acceptance:
    Increase.CheckDeposits.CheckDeposit.DepositAcceptance.t() | nil,
  deposit_adjustments: [
    Increase.CheckDeposits.CheckDeposit.DepositAdjustment.t()
  ],
  deposit_rejection:
    Increase.CheckDeposits.CheckDeposit.DepositRejection.t() | nil,
  deposit_return: Increase.CheckDeposits.CheckDeposit.DepositReturn.t() | nil,
  deposit_submission:
    Increase.CheckDeposits.CheckDeposit.DepositSubmission.t() | nil,
  description: String.t() | nil,
  front_image_file_id: String.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  inbound_funds_hold:
    Increase.CheckDeposits.CheckDeposit.InboundFundsHold.t() | nil,
  inbound_mail_item_id: String.t() | nil,
  lockbox_recipient_id: String.t() | nil,
  status: String.t(),
  transaction_id: String.t() | nil,
  type: String.t()
}