Create a test payout within this wallet's policy

POST

/v1/agent/payouts

curl --request POST \
  --url http://localhost:4000/v1/agent/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "amount": 15000, "currency": "XOF", "recipient": { "phone": "+221771234567", "name": "example" }, "action_id": "example" }'

The provider comes from the wallet policy. The recipient must be on the wallet’s allowlist. Reuse action_id for retries of the same business payout, even when the Idempotency-Key changes.

Authorizations

• agentBearerAuth

Parameters

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 Body^required

Media typeapplication/json

object

amount

required

Integer XOF

integer

> 0 <= 100000000

Example

15000

currency

string

default: XOF

Allowed values: XOF

recipient

required

object

phone

required

string

/^\+2217[0-9]{8}$/

Example

+221771234567

name

string

<= 100 characters

action_id

required

Stable business action ID, unique within this agent wallet. Reuse it when retrying the same payout.

string

>= 1 characters <= 100 characters

Responses

201

Agent payout

Media typeapplication/json

object

id

required

string

object

required

string

Allowed values: payout

agent_wallet_id

required

string | null

livemode

required

boolean

amount

required

integer

fee

required

integer

currency

required

string

provider

required

string

Allowed values: wave orange_money mock

status

required

string

Allowed values: pending processing succeeded failed

recipient

required

object

phone

required

string

name

required

string | null

client_reference

required

string | null

failure_reason

required

string | null

created_at

required

string

updated_at

required

string

Example

{
  "object": "payout",
  "provider": "wave",
  "status": "pending"
}

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