v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB

Wallets

Create Wallet

Endpoint to add a new Wallet. Only company wallets can be created, a user dedicated wallet for each currency supported by your account is automatically created by the Soldo platform.

post/business/v2/wallets/create

Request body

request_timestampinteger required

The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.

namestring required

The name of the Wallet.

descriptionstring

The description of the Wallet.

currency'EUR' | 'GBP' | 'USD' required

The ISO 4217 code of the currency of the Statement to search for.

owner_type'company'

Example request

{
  "request_timestamp": 1576850500000,
  "name": "John Doe",
  "description": "My company wallet",
  "currency": "EUR"
}

Response

The returned resource is a Wallet.

idstring

The Wallet ID (sortable: yes)

namestring

The name of the Wallet (sortable: yes)

currency_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

available_amountnumber

The currently available balance of the Wallet (sortable: no)

blocked_amountnumber

The blocked balance of the Wallet (the overall amount of Transactions in Authorised status) (sortable: no)

primary_user_type'main' | 'company' | 'employee' | 'dedicated'

The type of resource assigned to the Wallet.

primary_user_public_idstring

The ID of the User if the Wallet is of type employee, not available for other Wallet types (sortable: no)

custom_reference_idstring

The custom reference of the User if the Wallet is of type employee, not available for other wallet types (sortable: yes)

group_idstring

The ID of the Group the wallet is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.

groupsstring[]

The list of Group ID the wallet is related to (sortable: no)

labelstring

The label of the Wallet (sortable: yes)

visibleboolean

It determines whether the Wallet is visible on the web console (sortable: yes)

creation_timestring

The date and time when the Wallet was created (sortable: yes)

last_updatestring

The date and time when the Wallet was last updated (sortable: yes)

descriptionstring

The note of the Wallet (sortable: yes)

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "CompanyWallet1",
  "available_amount": 100,
  "primary_user_type": "company",
  "primary_user_public_id": "XMPL1234-000001",
  "custom_reference_id": "123456-usa-1",
  "group_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "groups": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "label": "CompanyWallet1",
  "visible": true,
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update": "2017-06-01T12:48:40Z",
  "deposit_account_info": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "description": "CompanyWallet1"
}