Read an agent wallet balance

GET

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

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

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

id

required

string

Responses

200

Agent wallet balance

Media typeapplication/json

object

object

required

string

Allowed values: agent_wallet_balance

wallet_id

required

string

livemode

required

boolean

currency

required

string

Allowed values: XOF

available

required

integer

pending_payouts

required

integer

Example

{
  "object": "agent_wallet_balance",
  "currency": "XOF"
}

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