Read the wallet policy bound to this agent key

GET

/v1/agent/wallet

curl --request GET \
  --url http://localhost:4000/v1/agent/wallet \
  --header 'Authorization: Bearer <token>'

Authorizations

• agentBearerAuth

Responses

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

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

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

401

Authentication error

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"
  }
}

422

Insufficient funds or policy violation

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

429

Rate limited; see Retry-After response header

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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