Create a payout (owner only)

POST

/dashboard/v1/merchants/{merchantId}/{mode}/payouts

curl --request POST \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/payouts \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "amount": 15000, "currency": "XOF", "provider": "wave", "recipient": { "phone": "+221771234567", "name": "example" }, "client_reference": "example" }'

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

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

provider

required

string

Allowed values: wave orange_money

recipient

required

object

phone

required

string

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

Example

+221771234567

name

string

<= 100 characters

client_reference

string

<= 100 characters

Responses

201

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

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

422

Insufficient funds

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

503

Temporarily unavailable

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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