Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).
Fields
id- The Account Transfer's identifier.account_id- The Account from which the transfer originated.amount- The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.approval- If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.cancellation- If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.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 transfer's currency.description- An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.destination_account_id- The destination Account's identifier.destination_transaction_id- The identifier of the Transaction on the destination Account representing the received funds.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.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.status- The lifecycle status of the transfer.transaction_id- The identifier of the Transaction on the originating account representing the transferred funds.type- A constant representing the object's type. For this resource it will always beaccount_transfer.
Summary
Types
@type t() :: %Increase.AccountTransfers.AccountTransfer{ account_id: String.t(), amount: integer(), approval: Increase.AccountTransfers.AccountTransfer.Approval.t() | nil, cancellation: Increase.AccountTransfers.AccountTransfer.Cancellation.t() | nil, created_at: DateTime.t(), created_by: Increase.AccountTransfers.AccountTransfer.CreatedBy.t() | nil, currency: String.t(), description: String.t(), destination_account_id: String.t(), destination_transaction_id: String.t() | nil, id: String.t(), idempotency_key: String.t() | nil, pending_transaction_id: String.t() | nil, status: String.t(), transaction_id: String.t() | nil, type: String.t() }