Skip to content

List wallets accessible to the caller (tenant-scoped)

GET
/api/v1/wallets
curl --request GET \
--url 'https://api.dokanmazad.com/api/v1/wallets?page=1&limit=20&tenantId=cmtenant0000001ny11aabbcc0' \
--header 'X-API-Key: <X-API-Key>'
page
number

Page number (default 1)

Example
1
limit
number

Items per page (default 20, max 500)

Example
20
tenantId
string

Tenant CUID — admin/super-admin only

Example
cmtenant0000001ny11aabbcc0

Success

Media typeapplication/json
object
success
required
boolean
data
required
meta
object
page
integer
limit
integer
total
integer
totalPages
integer
data
required
Array<object>
object
id
required

Wallet CUID

string
customerId
required

Owner customer CUID

string
balance
required

Current available balance

number
currency
required

Wallet currency (USD | AED | KRW)

string
updatedAt
required

Last update timestamp

string format: date-time
meta
object
page
integer
limit
integer
total
integer
totalPages
integer
Examples
Examplesuccess
{
"success": true,
"data": [
{
"id": "cmwallet000001ny11aabbcc0",
"customerId": "cmoabcde000001ny11aabbcc0",
"balance": 1500,
"currency": "USD",
"updatedAt": "2026-05-12T08:00:00.000Z"
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}

Unauthorized — missing or invalid API key

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}

Forbidden — route not in this key’s allowedRoutes

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}
Retry-After
integer

Seconds to wait before retrying