Skip to content
Xaalis

Create a test agent wallet with bounded payout permissions

POST
/v1/agent-wallets
curl --request POST \
  --url http://localhost:4000/v1/agent-wallets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "name": "example", "provider": "wave", "max_payout_amount": 15000, "allowed_recipient_phones": [ "+221771234567" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 2 characters <= 120 characters
provider
required
string
Allowed values: wave orange_money
max_payout_amount
required

Maximum XOF for one payout from this wallet

integer
> 0 <= 100000000
Example
15000
allowed_recipient_phones
required
Array<string>
>= 1 items <= 20 items

Responses

Section titled “ Responses ”

201

Section titled “201”

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

Section titled “400”

Validation error

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”

Authentication error

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

422

Section titled “422”

Insufficient funds

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

429

Section titled “429”

Rate limited; see Retry-After response header

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