Wallet

This endpoint can be used to retrieve the current wallet-status of the specified user. A wallet contains either budget, bundles, discount-bundles or a combination of those three.

Reference

GET /wallet/<userId>

Fields

field	type	description/constraints	Req	W	U
userId	int	The userId	Yes	No	No
walletUserId	boolean/int	The userId whose wallet is used if applicable Default: false	Yes	No	No
budget	object	Normal budget as paid for by the user by iDeal or Creditcard. See: budget-object	Yes	No	No
bundle	object	A bundle contains credits instead of budget. Each credit represents one publish-action for an advertisement. See: bundle-object	Yes	No	No
discountBundle	object	A discount bundle contains a regular budget, however, the user will receive a discount for each action as defined by field: percentage. See: discountBundle-object	Yes	No	No
flatrate	boolean	Is this a flat-rate account or not?A flat-rate account is an account for which the user will receive a monthly invoice based on the number of ads processed in that period.	Yes	No	No

Fields budget

field	type	description/constraints	Req	W	U
gross	int	The gross budget value in whole cents. Includes reservations for actions not yet processed by GoedGeplaatst.	Yes	No	No
reserved	int	The amount of budget reserved in whole cents for actions not yet processed by GoedGeplaatst.	Yes	No	No
net	int	The net-budget value in whole cents	Yes	No	No

Fields bundle

field	type	description/constraints	Req	W	U
gross	int	The gross amount of advertisements available Includes reservations for actions not yet processed by GoedGeplaatst.	Yes	No	No
reserved	int	The amount of advertisements reserved for actions not yet processed by GoedGeplaatst	Yes	No	No
net	int	The net amount of advertisements available	Yes	No	No

Fields discountBundle

field	type	description/constraints	Req	W	U
bundleId	int	The bundleId	Yes	No	No
productId	int	The productId of this bundle	Yes	No	No
description	string	The description of this discount bundle	Yes	No	No
amount	int	The total value of the discount bundle at the date it was purchased in whole cents	Yes	No	No
percentage	int	The discount-percentage applicable for this discount bundle	Yes	No	No
gross	int	The gross budget value in whole cents. Includes reservations for actions not yet processed by GoedGeplaatst.	Yes	No	No
reserved	int	The amount of budget reserved in whole cents for actions not yet processed by GoedGeplaatst	Yes	No	No
net	int	The net-budget value in whole cents	Yes	No	No

Example retrieving wallet

Request

GET /rest/v1/wallet/12311 HTTP/2

Response

{
 "result": true,
 "errors": [],
 "data": {
   "userId": 12311,
   "walletUserId": false,
   "budget": {
     "gross": 114702,
     "reserved": 0,
     "net": 114702
   },
   "bundle": {
     "gross": 0,
     "reserved": "0",
     "net": 0
   },
   "discountBundle": {
     "bundleId": 0,
     "productId": 0,
     "description": "",
     "amount": 0,
     "percentage": 0,
     "gross": 0,
     "reserved": 0,
     "net": 0
   }
 }
}