Update a Wallet

Path parameters

WalletId · string · required

The unique identifier of the wallet.

Body parameters

Description · 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).

Tag · 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.

Responses

200

Description · 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).

Owners · array

string

The unique identifier of the user owning the wallet.

Note: Only one owner can be defined; this array accepts only one string.

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Balance · object

The current balance of the wallet.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the balance.

Amount · 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).

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the wallet.

FundsType · 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.

Tag · 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.

CreationDate · Unix timestamp

The date and time at which the wallet was created.

200

{
    "Description": "New description of the wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Id": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "Balance": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Currency": "EUR",
    "FundsType": "DEFAULT",
    "Tag": "Updated using Mangopay API Postman collection",
    "CreationDate": 1724921476
}

REST

{
    "Description": "New description of the wallet",
    "Tag": "Updated using Mangopay API Postman collection"
}