List transactions

Retrieve a paginated list of transactions with optional filtering. The transactions can be filtered by customer ID, platform customer ID, UMA address, date range, status, and transaction type.

GET /transactions

JavaScript

JavaScript

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const transaction of client.transactions.list()) {
  console.log(transaction.id);
}

200

{
  "data": [
    {
      "receivedAmount": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
      "status": "CREATED",
      "type": "INCOMING",
      "destination": {
        "destinationType": "ACCOUNT",
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
        "currency": "EUR"
      },
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCustomerId": "18d3e5f7b4a9c2",
      "source": {
        "sourceType": "ACCOUNT",
        "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "currency": "USD"
      },
      "reconciliationInstructions": {
        "reference": "UMA-Q12345-REF"
      },
      "rateDetails": {
        "gridApiMultiplier": 0.925,
        "gridApiFixedFee": 10,
        "gridApiVariableFeeRate": 0.003,
        "gridApiVariableFeeAmount": 30
      },
      "failureReason": "LNURLP_FAILED",
      "settledAt": "2025-08-15T14:30:00Z",
      "createdAt": "2025-08-15T14:25:18Z",
      "updatedAt": "2025-08-15T14:30:00Z",
      "description": "Payment for invoice #1234",
      "counterpartyInformation": {
        "FULL_NAME": "John Sender",
        "BIRTH_DATE": "1985-06-15",
        "NATIONALITY": "DE"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Query Parameters

customerId · string

Filter by system customer ID

platformCustomerId · string

Filter by platform-specific customer ID

senderAccountIdentifier · string

Filter by sender account identifier

receiverAccountIdentifier · string

Filter by receiver account identifier

status · enum<string>

Filter by transaction status Status of a payment transaction

Available options: CREATED, PENDING, PROCESSING, COMPLETED, REJECTED, FAILED, REFUNDED, EXPIRED

type · enum<string>

Filter by transaction type Type of transaction (incoming payment or outgoing payment)

Available options: INCOMING, OUTGOING

reference · string

Filter by reference

startDate · string<date-time>

Filter by start date (inclusive) in ISO 8601 format

endDate · string<date-time>

Filter by end date (inclusive) in ISO 8601 format

limit · integer · default: 20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100

cursor · string

Cursor for pagination (returned from previous request)

sortOrder · enum<string> · default: desc

Order to sort results in

Available options: asc, desc

Response

200

application/json

Successful operation

data · object[] · required

List of transactions matching the criteria

Option 1

Option 2

Show child attributes

hasMore · boolean · required

Indicates if more results are available beyond this page

nextCursor · string

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCount · integer

Total number of transactions matching the criteria (excluding pagination)