Skip to main content

​
Overview

Settlement preferences control how Pepay settles funds to the merchant (for example, stable settlement token selection).

​
Authentication

Settlement preferences are dashboard-authenticated (Bearer JWT).

​
Request

​
Get settlement preferences

const prefs = await pepay.settlement.getPreferences();

​
Update settlement token

await pepay.settlement.updateSettlementToken({ settlement_token_id: 123 });

​
Response

Example preferences response (truncated): 
{
  "settlement_preference": "stables_preferred",
  "description": "Prefer stable coins when available, fallback to original token",
  "selected_settlement_token": {
    "id": 5,
    "token_symbol": "USDC",
    "network": "ethereum",
    "is_default": false
  },
  "updated_at": "2025-12-21T12:00:00.000Z"
}

​
Errors

  • 401 missing/invalid dashboard bearer token
  • 400 invalid settlement token id

​
Examples

  • If you update settlement token, verify downstream reporting uses the new preference before shipping to production.
Next: Events