Developers
Sales events5

Retrieve a sales event

GET/sales/events/{event_id}

Retrieves a sales event received from a payment gateway.

The original request headers sent by the gateway are never returned. The raw gateway payload is included only for credentials with the sales_events.read_payload permission, and is returned with sensitive data masked.

Imported data is not available through this operation; use the imports resource instead.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

event_id*string

Public ID of the event, prefixed with sev_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sales/events/string"
{  "data": {    "delivery_id": "string",    "external_id": "string",    "external_product_id": "string",    "gateway": "string",    "id": "string",    "object": "sales_event",    "payload": {},    "processing": {      "error": "string",      "state": "queued",      "updated_at": "2019-08-24T14:15:22Z"    },    "received_at": "2019-08-24T14:15:22Z",    "status": "trial",    "subscription_external_id": "string",    "transaction_id": "string",    "user_id": "string"  }}

List sales events GET

Returns the sales events received from payment gateways. The raw gateway payload is included only for credentials with the `sales_events.read_payload` permission, and payment and identity document fields are masked.

List processing attempts GET

Returns all processing attempts of a sales event in a single response while preserving the standard collection response format.