Skip to main content
GET
/
v2.01
/
{ClientId}
/
clients
/
wallets
/
{FundsType}
/
{Currency}
const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
    clientId: 'your-client-id',
    clientApiKey: 'your-api-key',
})

let myWallet = {
  FundsType: 'FEES',
  Currency: 'EUR',
}

const viewClientWallet = async (fundsType, currency) => {
  return await mangopay.Clients.getClientWallet(fundsType, currency)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

viewClientWallet(myWallet.FundsType, myWallet.Currency)  

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

​
Path parameters

​
FundsType
string
required
Allowed values: FEES, CREDITThe 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

200

​
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, CREDITThe 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 charactersCustom 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.
{
    "Balance": {
        "Currency": "EUR",
        "Amount": 2027
    },
    "Currency": "EUR",
    "FundsType": "FEES",
    "Id": "FEES_EUR",
    "Tag": null,
    "CreationDate": 1658926202
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
    clientId: 'your-client-id',
    clientApiKey: 'your-api-key',
})

let myWallet = {
  FundsType: 'FEES',
  Currency: 'EUR',
}

const viewClientWallet = async (fundsType, currency) => {
  return await mangopay.Clients.getClientWallet(fundsType, currency)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

viewClientWallet(myWallet.FundsType, myWallet.Currency)