Skip to main content
POST
/
v2.01
/
{ClientId}
/
wallets
{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Currency": "EUR",
    "Tag": "Created using Mangopay API Postman Collection",
}  

{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Id": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "Balance": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Currency": "EUR",
    "FundsType": "DEFAULT",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1724921476
}
Best practice – Create one wallet per user and currencyWhile Mangopay authorizes you to create as many wallets as required, we recommend you create one wallet per user and currency.
Caution – Currency not updatableThe Currency of a created wallet cannot be changed.

​
Body parameters

​
Description
string
required
Max. length: 255 charactersThe 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
required
stringThe unique identifier of the user owning the wallet.Note: Only one owner can be defined; this array accepts only one string.
​
Currency
string
required
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.
​
Tag
string
Max. length: 255 charactersCustom 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

​
Description
string
Max. length: 255 charactersThe 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
stringThe 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.
​
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.
​
Tag
string
Max. length: 255 charactersCustom 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.
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "c09ebc81-24d6-47ef-8cef-d491209faee8",
    "Date": 1702037849.0,
    "errors": {
        "Owners": "Owners doesn't support multiple values for the moment"
    }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "d3370a5b-af3c-4b99-9e6e-6c7dea052e19",
    "Date": 1690284549.0,
    "errors": {
        "Currency": "Currency: The currency AZN is not available"
    }
}  

{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Id": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "Balance": {
        "Currency": "EUR",
        "Amount": 0
    },
    "Currency": "EUR",
    "FundsType": "DEFAULT",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1724921476
}

{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Currency": "EUR",
    "Tag": "Created using Mangopay API Postman Collection",
}