​
Description

The Client Wallet object represents one of two wallets created automatically by Mangopay for each currency:
  • Fees Wallet - Stores all Fees taken on transactions (see the Fees guide for more information). The FundsType of the Fees Wallet is FEES.
  • Repudiation Wallet - Manages funds relating to disputes management. The FundsType of the Repudiation Wallet is CREDIT.
There can be only one wallet per FundsType and Currency.
Note – Latency of balance updateThe client wallet balance can take a few minutes to be updated after a transfer with fees has been done.

​
Attributes

​
Balance
object
The current balance of the wallet.
​
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, CREDITThe 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.
​
Id
string
The unique identifier of the wallet. In the specific case of the Client Wallet object, this value has the format FundsType_Currency (e.g., FEES_EUR).
​
Tag
string
Max. length: 255 charactersThis parameter usually allows you to enter custom data, but in the case of the Client Wallet object, it is always “null” as the object is automatically created.
​
CreationDate
Unix timestamp
The date and time at which the wallet was created.