Walletguide
DevelopersAPIReferencewallets

Create wallet

Create a wallet for the person you act for, with them as its owner, as they would in the app: with the default categories, and on their plan.

POST
/wallets

Authorization

bearerAuth
headerAuthorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 200
baseCurrency*string

The currency every number in the wallet is converted into.

Value in"EUR""AUD""BGN""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"
type?string

owned is a real wallet. sample is a wallet to try Walletguide with, deleted automatically after 14 days.

Default"owned"
Value in"owned""sample"
addSampleData?boolean

Fill the sample wallet with example assets and transactions, in the background. Only for type sample.

Defaultfalse
idempotencyKey*string

Any string unique to this wallet, such as a UUID you generate. Calling again with the same key and body returns the wallet already created instead of a second one.

Length1 <= length <= 200

Response Body

The wallet an earlier call with this idempotency key created

application/json
  1. response
wallet*
url*string

The wallet in the Walletguide app.

created*false
Value infalse
curl -X POST 'https://api.walletguide.com/wallets' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "baseCurrency": "EUR",  "idempotencyKey": "string"}'
{  "wallet": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "baseCurrency": "string",    "active": true,    "planSettings": {      "levels": [        "string"      ],      "showPercentageForPastMonths": true    },    "imagePath": "string",    "lastOverallUpdatedTime": "2019-08-24T14:15:22Z"  },  "url": "string",  "created": false}