Skip to content
Xaalis

Configure daily automatic payouts (owner only)

PATCH
/dashboard/v1/merchants/{merchantId}/{mode}/settlement-settings
curl --request PATCH \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/settlement-settings \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "enabled": true, "min_amount": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Header Parameters

Section titled “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 Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
boolean
min_amount

Minimum net XOF payout after the configured payout fee

integer
>= 1 <= 100000000
Examplegenerated
{
  "enabled": true,
  "min_amount": 1
}

Responses

Section titled “ Responses ”

200

Section titled “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

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

422

Section titled “422”

Provider unsupported

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Provider not configured

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}