Retrieve a payout

GET

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

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/payouts/example \
  --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

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