Read automatic settlement settings (owner only)

GET

/dashboard/v1/merchants/{merchantId}/{mode}/settlement-settings

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/settlement-settings \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Responses

200

Settlement settings

Media typeapplication/json

object

object

required

string

Allowed values: settlement_settings

merchant_id

required

string

livemode

required

boolean

enabled

required

boolean

min_amount

required

integer

schedule

required

string

Allowed values: 18:00 Africa/Dakar

last_run

required

object

id

required

string

local_day

required

string

status

required

string

Allowed values: pending queued skipped failed

amount

required

integer | null

payout

required

string | null

payout_status

required

string | null

Allowed values: pending processing succeeded failed

reason

required

string | null

created_at

required

string

Example

{
  "object": "settlement_settings",
  "schedule": "18:00 Africa/Dakar",
  "last_run": {
    "status": "pending",
    "payout_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"
  }
}