List events

GET/v1/events

The event log, newest first. Every event is listed, whether or not an endpoint received it.

Authorization

Send your API key as a bearer token in the Authorization header. Secret API key: Authorization: Bearer ctp_live_sk_…. A publishable key (ctp_…_pk_…) is accepted by these operations only, which serve reference data: getRate, listAssets, listNetworks (each marked x-publishable-key: true). Every other operation refuses it with 403 publishable_key_not_allowed, whatever Origin the request carries: that header binds browsers, not other clients, and nothing on this API relies on it.

Query parameters

Name	Type	Description
limit	integer	Number of items to return (1 to 100). Default 50. Minimum 1, maximum 100.
starting_after	string	Return items after this id: pass next_cursor of the previous page. At most 100 characters.
type	string	Only events of this type. At least 3 characters, at most 64 characters.

Example request

cURL

curl "https://api.ctpeway.com/v1/events" \
  -H "Authorization: Bearer $CTPEWAY_API_KEY"

Node SDK

import { CtpeWay } from '@ctpeway/sdk';

const ctpeway = new CtpeWay(process.env.CTPEWAY_API_KEY);

const result = await ctpeway.events.list();

Response

200 OK

Field	Type	Description
data	array of objects
data[].id	string	evt_….
data[].type	string
data[].api_version	string
data[].created	integer	Unix time in seconds.
data[].livemode	boolean
data[].data	object
data[].data.object	map of string to any	See webhooks.v1.json for the schema of each type.
has_more	boolean	Whether more items exist after this page.
next_cursor	string or null	Pass as starting_after to get the next page; null on the last page.

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "api_version": "string",
      "created": 0,
      "livemode": true,
      "data": {
        "object": {}
      }
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

The values are placeholders generated from the schema. They show the shape, not real data.

Errors

A failed request answers with the error format described under Errors.

Besides the codes any endpoint can return, this endpoint can answer with these code values:

• invalid_cursor