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
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).
string
The unique identifier of the user owning the wallet.
Note: Only one owner can be defined; this array accepts only one string.
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 thisFundsTypecannot 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 object.
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.
The date and time at which the object was created.
Related resources
Guide
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
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).
string
The unique identifier of the user owning the wallet.
Note: Only one owner can be defined; this array accepts only one string.
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 thisFundsTypecannot 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 object.
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.
The date and time at which the object was created.