WalletsUser wallets

Create a Wallet

Create a Mangopay wallet for a Mangoapy User. <Warning icon="fa-regular fa-triangle-exclamation"> **Caution – Currency not updatable** The `Currency` of a created wallet cannot be changed. </Warning>

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.
DescriptionstringRequired

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).

Ownerslist of stringsRequired

The unique identifier of the user owning the wallet.

Note: Only one owner can be defined; this array accepts only one string.

CurrencystringRequired

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.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success
Descriptionstring

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).

Ownerslist of strings

The unique identifier of the user owning the wallet.

Note: Only one owner can be defined; this array accepts only one string.

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Balanceobject
The current balance of the wallet.
Currencystring

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.

FundsTypestring

Returned values: DEFAULT, FEES, CREDIT

The 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.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the wallet was created.

Errors

400
Bad Request Error
403
Forbidden Error