List agent wallets

GET

/dashboard/v1/merchants/{merchantId}/{mode}/agent-wallets

curl --request GET \
  --url 'http://localhost:4000/dashboard/v1/merchants/example/test/agent-wallets?limit=20' \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Query Parameters

limit

integer

default: 20 >= 1 <= 100

starting_after

string

Responses

200

Agent wallets

Media typeapplication/json

object

object

required

string

Allowed values: list

data

required

Array<object>

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

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "agent_wallet",
      "status": "active",
      "provider": "wave",
      "allowed_recipient_phones": [
        "+221771234567"
      ]
    }
  ]
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Forbidden

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}