Create a Wallet
Best practice – Create one wallet per user and currency
While Mangopay authorizes you to create as many wallets as required, we recommend you create one wallet per user and currency.
Caution – Currency not updatable
The Currency
of a created wallet cannot be changed.
Body parameters
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.
Allowed 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.
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
200
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.
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
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.
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 wallet was created.
400 - Limited to one owner per wallet
400 - Limited to one owner per wallet
400 - Currency not supported
400 - Currency not supported