Skip to content
Xaalis

List payouts

GET
/dashboard/v1/merchants/{merchantId}/{mode}/payouts
curl --request GET \
  --url 'http://localhost:4000/dashboard/v1/merchants/example/test/payouts?limit=20' \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
merchantId
required
string
mode
required
string
Allowed values: test live

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 100
starting_after
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Payouts

Media typeapplication/json
object
object
required
string
Allowed values: list
data
required
Array<object>
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
has_more
required
boolean
Example
{
  "object": "list",
  "data": [
    {
      "object": "payout",
      "provider": "wave",
      "status": "pending"
    }
  ]
}

400

Section titled “400”

Invalid request

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”

Sign-in required

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