Retrieve an event

GET/v1/events/{id}

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.

Path parameters

Name	Type	Description
id required	string	At most 100 characters.

Example request

cURL

curl "https://api.ctpeway.com/v1/events/{id}" \
  -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.retrieve('<id>');

Response

200 OK

Field	Type	Description
id	string	evt_….
type	string
api_version	string
created	integer	Unix time in seconds.
livemode	boolean
data	object
data.object	map of string to any	See webhooks.v1.json for the schema of each type.

{
  "id": "string",
  "type": "string",
  "api_version": "string",
  "created": 0,
  "livemode": true,
  "data": {
    "object": {}
  }
}

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:

• event_not_found