GET
/
v2.01
/
{ClientId}
/
clients
/
wallets
/
{FundsType}
/
{Currency}

Path parameters

FundsType
string
required

Allowed values: FEES, CREDIT

The type of funds in the Client Wallet:

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

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.

Responses

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

Id
string

The unique identifier of the wallet. In the specific case of the Client Wallet object, this value has the format FundsType_Currency (e.g., FEES_EUR).

Tag
string

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.

CreationDate
timestamp

The date and time at which the wallet was created.