WalletsClient wallets

The Client Wallet object

Description

The Client Wallet object represents one of two wallets created automatically by Mangopay for the platform in each currency:

  • Fees Wallet - Stores all Fees taken on transactions by the platform and paid out by Mangopay automatically as part of the billing cycle (see the Fees guide). The FundsType of the Fees Wallet is FEES.
  • Repudiation Wallet - Manages funds relating to disputes management. The FundsType of the Repudiation Wallet is CREDIT.

There can be only one wallet per FundsType and Currency.

Note – Latency of balance update

The client wallet balance can take a few minutes to be updated after a transfer with fees has been done.

Attributes

BalanceobjectOptional
The current balance of the wallet.
CurrencystringOptional

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.

FundsTypestringOptional

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.

IdstringOptional

The unique identifier of the wallet.

The Id of Client Wallet object has the format FundsType_Currency, for example: FEES_EUR, CREDIT_GBP, etc.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateintegerOptional

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