Payments

Retrieves a summary of payments.

get

Returns aggregated payment information (total payments, revenue, etc.). Can be filtered by testMode to include/exclude test transactions.

Query parameters

testModebooleanOptional

If true, only test mode payments are returned. Defaults to false.

Default: false

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/analytics/payments/summary HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "totalPayments": 2500,
    "totalSells": 1200,
    "totalRevenue": 95000,
    "dailySells": 80,
    "dailyRevenue": 6750
  },
  "errors": []
}