Settlement Settings

Your settlement bank account and auto-settle threshold.

Configure where collected funds are swept and when. When auto-settle is on and a bank account is set, fully-paid accounts are settled automatically.

Auto-settle needs BOTH account and bank code

Setting autoSettle: true alone does nothing — the sweep only runs when settlementAccountNumber and settlementBankCode are also present.

Min payout threshold

Accounts below minPayoutKobo are held back from settlement until they clear the threshold.

get/api/v1/settings/settlement

Current settlement configuration for the account.

Requires Bearer token

Responses

200OK

GET /api/v1/settings/settlement

curl -X GET "https://api.xental.online/api/v1/settings/settlement" \
  -H "Authorization: Bearer <API_TOKEN>"

put/api/v1/settings/settlement

Set the settlement bank account and auto-settle threshold.

Requires Bearer token

Body parameters

settlementAccountNumberstringoptional

settlementBankCodestringoptional

settlementAccountNamestringoptional

autoSettlebooleanoptional

minPayoutKobointegeroptional

Responses

200OK

PUT /api/v1/settings/settlement

curl -X PUT "https://api.xental.online/api/v1/settings/settlement" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "autoSettle": false,
    "minPayoutKobo": 500000
  }'

Example request body

{
  "autoSettle": false,
  "minPayoutKobo": 500000
}