WalletsClient wallets

View a Client Wallet

View a Client Wallet

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.
FundsTypestringRequired
**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.
CurrencystringRequired
**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.

Response

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

Idstring

The unique identifier of the wallet.

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

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.