Skip to main content

​
Overview

Settlement endpoints control how and where funds are settled for your merchant account (preferences and selected settlement token).

​
Authentication

Dashboard-authenticated (Bearer JWT).

​
Request

Endpoints:
  • GET /api/v1/merchant/settlement-preference
  • PUT /api/v1/merchant/settlement-token
Example (fetch settlement preference): 
BASE_URL=${PEPAY_API_URL}

curl "$BASE_URL/api/v1/merchant/settlement-preference" \
  -H "Authorization: Bearer <jwt>"

​
Response

Representative response: 
{
  "settlement_preference": "stables_preferred",
  "description": "Prefer stable coins when available, fallback to original token",
  "selected_settlement_token": {
    "id": 5,
    "token_symbol": "USDC",
    "token_name": "USD Coin",
    "network": "ethereum",
    "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "token_decimals": 6,
    "is_default": false
  },
  "available_stable_tokens": [],
  "updated_at": "2025-12-21T12:34:56.000Z"
}

​
Errors

  • 401/403 missing/invalid bearer token
  • 400 invalid settlement token selection

​
Examples

Example (update settlement token): 
BASE_URL=${PEPAY_API_URL}

curl -X PUT "$BASE_URL/api/v1/merchant/settlement-token" \
  -H "Authorization: Bearer <jwt>" \
  -H "Content-Type: application/json" \
  -d '{"settlement_token_id":5}'
Next: Tokens