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

# The Wallet object

### Description

The Wallet object is the digital e-wallet on which funds are stored in the Mangopay environment.

A wallet can be used in the following ways:

* Make payments into a wallet (pay-in)
* Move funds from one wallet to another (transfer)
* Convert funds between wallets of different currencies (conversion)
* Withdraw funds from a wallet to a bank account (payout)

### Attributes

<ParamField body="Description" type="string">
  Max. length: 255 characters

  The description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users).
</ParamField>

<ParamField body="Owners" type="array">
  string

  The unique identifier of the user owning the wallet.

  **Note:** Only one owner can be defined; this array accepts only one string.
</ParamField>

<ParamField body="Balance" type="object">
  The current balance of the wallet.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

      The currency of the balance.
    </ParamField>

    <ParamField body="Amount" type="integer">
      An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="Currency" type="string">
  **Returned values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

  The currency of the wallet.
</ParamField>

<ParamField body="FundsType" type="string">
  **Returned values:** `DEFAULT`, `FEES`, `CREDIT`

  The type of funds in the wallet:

  * `DEFAULT` – Regular funds for user-owned wallets. Wallets with this `FundsType` cannot have a negative balance.
  * `FEES` – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.
  * `CREDIT` – Repudiation Wallet, for funds for the platform's dispute management, specific to the Client Wallet object.

  **Note:** The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency.
</ParamField>

<ParamField body="Id" type="string">
  The unique identifier of the object.
</ParamField>

<ParamField body="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.\
  For wallets, you can use this parameter to identify the corresponding end user in your platform.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

### Related resources

<Card title="Guide" href="/guides/e-wallet-system">Learn more about the wallet system</Card>
