Get All User Wallet Locks API

Overview

Retrieve a list of all user wallet lock records with optional filtering capabilities. This API allows you to fetch wallet lock information based on various criteria such as wallet ID, wallet type, user wallet ID, and user ID.

API Details

Method: GET
URL: https://api.gafapay.com:8443/gafapay/v3/transaction/user_wallet_lock
Content-Type: application/json
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: b1910650-f892-496a-b5a3-b0560845c4a1
Authorization: Token required

Endpoint

GET https://api.gafapay.com:8443/gafapay/v3/transaction/user_wallet_lock

Headers

companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: b1910650-f892-496a-b5a3-b0560845c4a1
authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU4OTY2OTAzfQ.4e8MwJFrhoh2-vSvyR-s828TmEbgpYp-ocHlfo3Fnu4
Content-Type: application/json

Query Parameters

Parameter	Type	Required	Description	Example
`wallet_id`	string	No	Filter by wallet ID	`?wallet_id=3a3d4e585aeb49e8bf3f3996fca0f82f`
`wallet_type`	integer	No	Filter by wallet type (1=Main, 2=Category, 3=Saving, 4=Revenue, 5=Commission)	`?wallet_type=3`
`user_wallet_id`	string	No	Filter by user wallet ID	`?user_wallet_id=fe058fb46ff24584a542144e0efe51eb`
`user_id`	string	No	Filter by user ID	`?user_id=e4946877f18946b299fddf0f2133dcba`
`skip`	integer	No	Number of records to skip (pagination)	`?skip=0`
`limit`	integer	No	Maximum number of records to return (pagination)	`?limit=10`
`start_date`	long	No	Filter by start date (Unix timestamp)	`?start_date=1758644000`
`end_date`	long	No	Filter by end date (Unix timestamp)	`?end_date=1759157657`

cURL Request

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/user_wallet_lock?user_id=e4946877f18946b299fddf0f2133dcba' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU4OTY2OTAzfQ.4e8MwJFrhoh2-vSvyR-s828TmEbgpYp-ocHlfo3Fnu4' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: b1910650-f892-496a-b5a3-b0560845c4a1' \
--header 'Content-Type: application/json'

Response

{
    "success": 1,
    "error": [],
    "data": {
        "user_wallet_locks": [
            {
                "id": "ceef44967b924390a6c2e911049a55a1",
                "wallet_id": "3a3d4e585aeb49e8bf3f3996fca0f82f",
                "wallet_type": 3,
                "user_wallet_id": "fe058fb46ff24584a542144e0efe51eb",
                "currency_id": "1f1519903ed240578f071aa45cb479f2",
                "locked_amount": 10.0,
                "locked_date": 1758644007,
                "maturity_date": 1759157657,
                "user_id": "e4946877f18946b299fddf0f2133dcba",
                "is_active": true,
                "created_by": "e4946877f18946b299fddf0f2133dcba",
                "created_date": 1758644007,
                "updated_by": "e4946877f18946b299fddf0f2133dcba",
                "updated_date": 1758645216
            }
        ]
    }
}

Response Fields

Field	Type	Description
`success`	integer	Status indicator (1 = success, 0 = failure)
`error`	array	Array of error messages (empty on success)
`data.user_wallet_locks`	array	Array of user wallet lock objects

User Wallet Lock Object Fields

Field	Type	Description
`id`	string	Unique identifier of the wallet lock
`wallet_id`	string	Unique identifier of the wallet
`wallet_type`	integer	Type of wallet (1=Main, 2=Category, 3=Saving, 4=Revenue, 5=Commission)
`user_wallet_id`	string	Unique identifier of the user wallet
`currency_id`	string	Unique identifier of the currency
`locked_amount`	double	Amount locked in the wallet
`locked_date`	long	Unix timestamp when the amount was locked
`maturity_date`	long	Unix timestamp when the lock expires
`user_id`	string	Unique identifier of the user
`is_active`	boolean	Whether the wallet lock is active
`created_by`	string	User ID who created the wallet lock
`created_date`	long	Unix timestamp when the record was created
`updated_by`	string	User ID who last updated the wallet lock
`updated_date`	long	Unix timestamp when the record was last updated

Filtering Options

By Wallet: Filter locks for a specific wallet using wallet_id
By Wallet Type: Filter locks by wallet type using wallet_type
By User Wallet: Filter locks for a specific user wallet using user_wallet_id
By User: Filter locks for a specific user using user_id
By Date Range: Filter locks within a date range using start_date and end_date

Overview​

API Details​

Endpoint​

Headers​

Query Parameters​

cURL Request​

Response​

Response Fields​

User Wallet Lock Object Fields​

Filtering Options​