The Client Wallet object
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). TheFundsType
of the Fees Wallet isFEES
. - Repudiation Wallet - Manages funds relating to disputes management. The
FundsType
of the Repudiation Wallet isCREDIT
.
There can be only one wallet per FundsType
and Currency
.
Note – Latency of balance update
The client wallet balance can take a few minutes to be updated after a transfer with fees has been done.
Attributes
The current balance of the wallet.
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.
Returned values: DEFAULT
, FEES
, CREDIT
The type of funds in the wallet:
DEFAULT
– Regular funds for user-owned wallets. Wallets with thisFundsType
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.
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
).
Max. length: 255 characters
This 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.
The date and time at which the wallet was created.
Was this page helpful?