List transaction events

Retrieve a paginated list of events related to processing a transaction, including status changes, API requests, and webhook delivery attempts. Events are listed in chronological order, with the most recent events first.

GET /transactions/{transaction_id}/events

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListTransactionEventsResponse? res = await sdk.Transactions.Events.ListAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    cursor: "ZXhhbXBsZTE",
    limit: 100
);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "context": {},
      "type": "transaction-event"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

This endpoint requires the transactions.read scope.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id · string

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

transaction_id · string<uuid> · required

The ID of the transaction

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

Query Parameters

cursor · string | null

A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit · integer · default: 100

The maximum number of items that are at returned.

Required range: 1 <= x <= 500

Example:

100

Response

200

application/json

Successful Response

items · TransactionEvent · object[] · required

A list of items returned for this request.

Show child attributes

limit · integer · default: 20

The number of items for this page.

Required range: 1 <= x <= 100

Example:

20

next_cursor · string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor · string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"