> ## Documentation Index
> Fetch the complete documentation index at: https://docs.monime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Internal Transfer

An **Internal Transfer** is the movement of funds between financial accounts that exist within the same Space.\
Unlike payouts or customer payments that cross external networks (banks, card schemes, or mobile money), an Internal Transfer happens entirely within Monime’s ledger.

It is the mechanism for shifting balances between accounts you own or manage, and it never leaves your organization’s financial boundary.

***

### Use Cases

* **Wallet Top-ups**\
  A customer wallet account can be funded by moving money from your master operational account.\
  *Example*: A user adds **SLE 1,000** to their app wallet. Your backend issues an Internal Transfer from your **Operational Float** to the user’s **Wallet Account**.

* **Inter-Account Routing**\
  Businesses often separate funds for accounting clarity (e.g., “Card Collections,” “Mobile Money Collections,” “Bank Transfers”).\
  *Example*: At the end of each day, you route all **Mobile Money collections** into a central **Settlement Account**.

* **Internal Settlements**\
  Useful when multiple departments or sub-entities operate under one Space.\
  *Example*: Subsidiary A owes Subsidiary B **SLE 50,000**. Instead of moving money through the banking system, you perform an Internal Transfer inside your Monime ledger.

* **Float Management**\
  Fintechs maintain float across accounts to support disbursements.\
  *Example*: If your **Disbursement Account** is running low, you move funds from your **Collection Account** to top it up before processing payouts.

***

<ResponseExample>
  ```json JSON Model theme={null}
  {
      "id": null,
      "status": "pending",
      "amount": {
          "currency": null,
          "value": null
      },
      "sourceFinancialAccount": {
          "id": null
      },
      "destinationFinancialAccount": {
          "id": null
      },
      "financialTransactionReference": null,
      "description": null,
      "failureDetail": {
          "code": "unknown",
          "message": null
      },
      "ownershipGraph": {
          "owner": {
              "id": null,
              "type": null,
              "metadata": null,
              "": null
          }
      },
      "createTime": null,
      "updateTime": null,
      "metadata": null
  }
  ```
</ResponseExample>

<ResponseField name="📋" type="Properties">
  <ResponseField name="id" type="string">
    Unique identifier for this transfer object.
  </ResponseField>

  <ResponseField name="status" type="enum<string>">
    Current status of the transfer:

    * 'pending': Created but not yet processed.
    * 'processing': Currently being processed.
    * 'failed': Transfer failed.
    * 'completed': Transfer successfully completed.

    Available options: <code>pending</code> <code>processing</code> <code>failed</code> <code>completed</code>
  </ResponseField>

  <ResponseField name="amount" type="object">
    Amount to be transferred from the source to the destination account.

    <Expandable title="properties">
      <ResponseField name="currency" type="string">
        The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO currency code. Currently supported: 'SLE', 'USD'
      </ResponseField>

      <ResponseField name="value" type="integer">
        The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="sourceFinancialAccount" type="object">
    Source financial account from which the funds will be debited.

    <Expandable title="properties">
      <ResponseField name="id" type="string">
        Unique identifier for the financial account
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="destinationFinancialAccount" type="object">
    Destination financial account to which the funds will be credited.

    <Expandable title="properties">
      <ResponseField name="id" type="string">
        Unique identifier for the financial account
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="financialTransactionReference" type="string">
    Reference to the resulting financial transaction(s), if the transfer was completed.
  </ResponseField>

  <ResponseField name="description" type="string">
    Human-readable description of the transfer. Useful for developer context, admin UIs, or logs.
  </ResponseField>

  <ResponseField name="failureDetail" type="object">
    Failure details, populated only when the transfer status is 'failed'.

    <Expandable title="properties">
      <ResponseField name="code" type="enum<string>">
        **Error code** representing the reason this transfer failed. Possible values include:

        * **unknown**: Generic or unclassified failure.
        * **fund\_insufficient**: Not enough funds in the source account.

        Available options: <code>unknown</code> <code>fund\_insufficient</code>
      </ResponseField>

      <ResponseField name="message" type="string">
        **Optional explanation** providing more context about the failure. Useful for developer logs or end-user display.
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="ownershipGraph" type="object">
    Ownership chain that shows which object or action triggered the transfer — enabling audit traceability.

    <Expandable title="properties">
      <ResponseField name="owner" type="object">
        **Immediate object** that owns this entity. This is the direct originator or source object.

        <Expandable title="properties">
          <ResponseField name="id" type="string">
            **Unique ID** of the object instance that owns this entity.
          </ResponseField>

          <ResponseField name="type" type="string">
            **Type of the object** that owns this entity. Examples include: 'internal\_transfer', 'checkout\_session', 'payment\_code'.
          </ResponseField>

          <ResponseField name="metadata" type="object">
            **Arbitrary metadata** describing the owning object.
          </ResponseField>

          <ResponseField name="" type="" />
        </Expandable>
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="createTime" type="string">
    Timestamp indicating when the transfer was created.
  </ResponseField>

  <ResponseField name="updateTime" type="string">
    Timestamp of the most recent update to the transfer.
  </ResponseField>

  <ResponseField name="metadata" type="object">
    Custom metadata for tagging this transfer with additional context or identifiers.
  </ResponseField>
</ResponseField>
