To use this feature the wallet_enabled setting must be enabled
Action | Method | Resource | Description |
---|---|---|---|
Get all | GET | /wallets | Get all wallets from all users Only admin |
Get all | GET | /users/user_id/wallets | Get all wallets from a user with user_id |
Get | GET | /wallets/wallet_id | Get wallet by id with wallet_id Only Admin |
Get | GET | /users/user_id/wallets/wallet_id | Get wallet by user id and wallet id with user_id and wallet_id |
UPDATE | PUT | /wallets/wallet_id | Update wallet by id Only admin |
UPDATE | PUT | /users/user_id/wallets/wallet_id | Update wallet by user id and wallet id with: user_id and wallet_id |
The Wallet model is composed of the following attributes:
Attribute | Type | Required | Description | whereable |
---|---|---|---|---|
id | Integer | No | Identifier of the wallet | |
code | String | No | Identifier for the wallet address | |
type | String | No | The wallet's cash/credit_point. | |
user_id | Integer | No | Identifier of the user which the wallet belongs to. | |
balance | Float | No | Balance (amount) of the wallet | |
locked | Boolean | Yes | Identifier to know if the wallet is locked: If true , you can't make any transaction | |
locked_reason | String | No | Reason why the wallet is locked. Can be manually lock by the admin | |
locked_at | Timestamp | No | Date when it was locked | |
created_at | Timestamp | No | Date when the wallet was created | |
updated_at | Timestamp | No | Date when the wallet was updated |