Check Transfers move funds from your Increase account by mailing a physical check.
Fields
id- The Check transfer's identifier.account_id- The identifier of the Account from which funds will be transferred.account_number- The account number printed on the check.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.approved_inbound_check_deposit_id- If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit. The Inbound Check Deposit object will have information about any associated Transactions for this Check Transfer.balance_check- How the account's available balance should be checked.cancellation- If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.check_number- The check number printed on the check.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.currency- The ISO 4217 code for the check's currency.fulfillment_method- Whether Increase will print and mail the check or if you will do it yourself.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.mailing- If the check has been mailed by Increase, this will contain details of the shipment.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.physical_check- Details relating to the physical check that Increase will print and mail. Will be present if and only iffulfillment_methodis equal tophysical_check.routing_number- The routing number printed on the check.source_account_number_id- The identifier of the Account Number from which to send the transfer and print on the check.status- The lifecycle status of the transfer.stop_payment_request- After a stop-payment is requested on the check, this will contain supplemental details.submission- After the transfer is submitted, this will contain supplemental details.third_party- Details relating to the custom fulfillment you will perform. Will be present if and only iffulfillment_methodis equal tothird_party.type- A constant representing the object's type. For this resource it will always becheck_transfer.valid_until_date- If set, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.
Summary
Types
@type t() :: %Increase.CheckTransfers.CheckTransfer{ account_id: String.t(), account_number: String.t(), amount: integer(), approval: Increase.CheckTransfers.CheckTransfer.Approval.t() | nil, approved_inbound_check_deposit_id: String.t() | nil, balance_check: String.t() | nil, cancellation: Increase.CheckTransfers.CheckTransfer.Cancellation.t() | nil, check_number: String.t(), created_at: DateTime.t(), created_by: Increase.CheckTransfers.CheckTransfer.CreatedBy.t() | nil, currency: String.t(), fulfillment_method: String.t(), id: String.t(), idempotency_key: String.t() | nil, mailing: Increase.CheckTransfers.CheckTransfer.Mailing.t() | nil, pending_transaction_id: String.t() | nil, physical_check: Increase.CheckTransfers.CheckTransfer.PhysicalCheck.t() | nil, routing_number: String.t(), source_account_number_id: String.t() | nil, status: String.t(), stop_payment_request: Increase.CheckTransfers.CheckTransfer.StopPaymentRequest.t() | nil, submission: Increase.CheckTransfers.CheckTransfer.Submission.t() | nil, third_party: Increase.CheckTransfers.CheckTransfer.ThirdParty.t() | nil, type: String.t(), valid_until_date: Date.t() | nil }