List Client Wallets by FundsType

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.

Responses

200

Array (Client Wallets) · array

The list of Client Wallets.

Show properties

Object (Client Wallet) · object

The Client Wallet object created by MANGOPAY.

Show properties

Balance · object

The current balance of the wallet.

Show properties

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

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

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.

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

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 · Unix timestamp

The date and time at which the wallet was created.

200

[
    {
        "Balance": {
            "Currency": "EUR",
            "Amount": 1027
        },
        "Currency": "EUR",
        "FundsType": "FEES",
        "Id": "FEES_EUR",
        "Tag": null,
        "CreationDate": 1658926202
    }
]  

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

//To get only Fees Wallets
try {
    $fundsType = \MangoPay\FundsType::FEES;
    $response = $api->Clients->GetWallets($fundsType);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}

// To only get Credit Wallets 
try {
    $fundsType = \MangoPay\FundsType::CREDIT
    $response = $api->Clients->GetWallets($fundsType);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}