The Client Wallet object

The client wallet is very similar to a normal wallet except the parameters "Description" and "Owners" are removed. Currently, there are two types of client wallet (specified by the "FundsType" parameter) - "FEES" where your collected turnover is stored and "CREDIT" where repudiations are taken from. A normal wallet for a user has the "FundsType" of "DEFAULT".

Client wallets are created automatically when they're first required; and there is only one client wallet "FundsType" per currency

Note that you view the transactions for a client wallet here.

We set up a system of aliasing so the naming of your wallets is clearer for you. For example, your wallets in the currency EUR will be called FEES_EUR and CREDIT_EUR.

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Balance
Money

Money:

View Sub-parameters

The current balance of the wallet

Balance.Currency
CurrencyIso

CurrencyIso:

EUR, USD, GBP, PLN, CHF, NOK, SEK, DKK, CAD, ZAR, XXX

ISO 4217 format

The currency - should be ISO_4217 format

Balance.Amount
int

int

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

FundsType
FundsType

FundsType:

DEFAULT, FEES, CREDIT

The type of funds in the wallet

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Balance": {
"Currency": "EUR",
"Amount": 12
},
"FundsType": "DEFAULT"
}

List all Client Wallets

It is possible to view your Fees and Credit Wallets thanks to the API calls below.

GET .../v2.01/ClientId

The ID of your client account

/clients/wallets/

Get parameters

Page
int

int

optional

The page number of results you wish to return

Per_Page
int

int

optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :

optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../clients/wallets/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../clients/wallets/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}

View a Client Wallet

GET .../v2.01/ClientId

The ID of your client account

/clients/wallets/FundsType

The type of funds in the wallet

/Currency

The currency - should be ISO_4217 format

/
  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../clients/wallets/:FundsType/:Currency/ HTTP/1.1
GET .../clients/wallets/// HTTP/1.1

List Client Wallets by FundsType

GET .../v2.01/ClientId

The ID of your client account

/clients/wallets/FundsType

The type of funds in the wallet

/

Get parameters

Page
int

int

optional

The page number of results you wish to return

Per_Page
int

int

optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :

optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    A code sample is not available
  • Run
  • View
  • Code
    A code sample is not available
  • Run
GET .../clients/wallets/:FundsType/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../clients/wallets// HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}