Skip to main content
GET
/
cpl
/
payments
Payments
curl --request GET \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/payments \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": [
    {
      "order_id": "cplo_xxxxxxx",
      "amount": 123,
      "quantity": 123,
      "wallet_tx_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "2023-11-07T05:31:56Z",
      "date_ts": 123
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 150,
    "total_pages": 3,
    "has_next": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

​
page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
​
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
​
order_id
string

Filter to a single order's payments (e.g. cplo_xxxxxxx).

Maximum string length: 32
​
type
enum<string>
Available options:
prepayment,
chunk,
postpayment,
revert
​
from
string<date>

Lower bound on the resource date (YYYY-MM-DD, UTC, inclusive).

​
to
string<date>

Upper bound on the resource date (YYYY-MM-DD, UTC, inclusive).

​
sort
enum<string>
default:date_desc

Sort order.

  • date_desc: newest payments first (default).
  • date_asc: oldest payments first.
  • amount_desc: largest amount first.
  • amount_asc: smallest amount first.
  • order_id_asc: group by order id, ascending.
  • order_id_desc: group by order id, descending.
Available options:
date_desc,
date_asc,
amount_desc,
amount_asc,
order_id_asc,
order_id_desc

Response

Successful response

​
success
boolean
Example:

true

​
data
object[]
​
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.