Skip to content
Paysum

Overview

Base URL, authentication, request format and pagination for the Paysum API.

The Paysum API is a JSON-over-HTTPS REST API. Requests and responses use application/json, timestamps are ISO 8601 strings in UTC, and amounts are plain numbers in the store’s currency.

Store API #

Manage the store a key belongs to. Each resource has its own read and write scope, and the same operations are available to AI assistants through the MCP server.

Products Catalog, prices, stock and categories. Orders Paid orders with line items and deliveries. Customers Buyers, spend and order counts. Coupons Create and schedule discount codes. Theme Edit theme code, preview and publish. Store Name, address, currency and the key’s scopes.

Payments API #

Take payments in your own product and move money out of the store.

Checkout sessions Create, retrieve, list and cancel hosted checkouts. Withdrawals Inspect wallets and create or track crypto payouts. Customer balance Find customers and manage store balances.

OpenAPI specification #

Download the OpenAPI 3.1 specification to import the supported endpoints into your API client. It includes request parameters, permission requirements, and response examples from this reference.

Public API and dashboard endpoints

A store API key can only call the endpoints documented here. Requests the dashboard makes in your browser are internal and are not available to keys, so use the documented endpoints and scopes rather than copying one.

Base URL #

https://paysum.io

Authentication #

Send a store API key as a bearer token on every request. See Authentication for permissions and key management.

Authorization: Bearer sk_your_secret_key

Pagination #

List endpoints accept limit (1–100, default 20) and offset (default 0) and return the total alongside the page:

{
  "data": [
    "…"
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

List orders returns next_offset instead of a total; pass it as offset until it is null.

A reliable integration #

  1. Keep your store API key in a server environment variable.
  2. Start with a read-only request using the least permission you need.
  3. Inspect the HTTP status before parsing a response as successful.
  4. Record resource IDs and your own order reference when creating a session or payout.
  5. Verify payment using session status or a signed webhook before delivering custom goods.
  6. Check the recorded outcome before retrying a timed-out balance change or withdrawal.

Endpoints #

Store API #

Payments API #