Endpoints

Get balance

GET/api/v1/me/balance

Available, pending, frozen, and reserve balances.

GET/api/v1/me/balancesecret key

Return the merchant's current balance: available, pending settlement, frozen (held against open claims), and rolling reserve — plus a fee summary, tier and withdrawal fee.

Request

curl https://sandbox.key2pay.ai/api/v1/me/balance \
  -H "Authorization: Bearer sk_test_51N8mP...exampleK3Y"

Response

{
  "merchantId": "MCH-…",
  "currency": "USD",
  "balance": {
    "available": 12480.55,
    "pending": 230.10,
    "frozen": 0,
    "reserve": 1500.00
  },
  "ledgerWarnings": [],
  "tier": "standard",
  "trustScore": 540,
  "rollingReservePct": 5,
  "withdrawalFeeUsd": 1,
  "feeSummary": {
    "grossVolume": 18230.00,
    "platformFees": 540.20,
    "flatFees": 12.00,
    "chargebackFees": 0,
    "totalFees": 552.20,
    "netBalance": 12480.55
  },
  "movements": [],
  "reserveSchedule": []
}