API Overview

uPayments provides a REST API for programmatic access to your payment data.

Base URL

https://test-dashboard.upayments.io/api

All API requests require authentication via session cookie (for browser requests) or API key (for server-to-server).

Public API key access is available on the Scale tier. See Settings → API Keys to generate keys.

All endpoints return JSON:

{
  "data": { ... },
  "error": null
}

Error responses:

{
  "error": "Human-readable error message"
}

Code	Meaning
200	Success
201	Created
400	Bad request (invalid parameters)
401	Unauthorized (not logged in)
403	Forbidden (insufficient permissions)
404	Not found
429	Rate limited
500	Server error

⌘I