Developers
Sales events5

List sales events

GET/sales/events

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.

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
gateway?string

Only events received from the gateway with this public ID.

delivery_id?string

Only events of the delivery with this public ID.

transaction_id?string

Only events of the transaction with this public ID.

processing?string

Only events with this processing state.

Value in

  • "queued"
  • "processed"
  • "failed"
  • "ignored"
status?string

Only events with this sale status.

received_after?string

Only items received after this date and time (ISO 8601).

Formatdate-time
received_before?string

Only items received before this date and time (ISO 8601).

Formatdate-time

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

application/json

curl -X GET "https://example.com/sales/events"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Sales events5

Sales events in API v3: list sales events, retrieve a sales event, list processing attempts, create a processing attempt, retrieve a processing attempt.

Retrieve a sales event GET

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.