Skip to content
Xaalis

Read an agent wallet

GET
/dashboard/v1/merchants/{merchantId}/{mode}/agent-wallets/{id}
curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/agent-wallets/example \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
merchantId
required
string
mode
required
string
Allowed values: test live
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Agent wallet

Media typeapplication/json
object
id
required
string
object
required
string
Allowed values: agent_wallet
livemode
required
boolean
name
required
string
status
required
string
Allowed values: active disabled
provider
required
string
Allowed values: wave orange_money
max_payout_amount
required
integer
max_daily_amount
required
integer | null
allowed_recipient_phones
required
Array<string>
created_at
required
string
updated_at
required
string
Example
{
  "object": "agent_wallet",
  "status": "active",
  "provider": "wave",
  "allowed_recipient_phones": [
    "+221771234567"
  ]
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}