Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
wallets

Update a Wallet

Modify a wallet.

put/v2.01/{ClientId}/wallets/{WalletId}

Path parameters

ClientIdstring required

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

WalletIdstring required

The unique identifier of the wallet.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Request body

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

Tagstring

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

Ownersstring[]

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.

Currencystring

Allowed values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (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.