List transactions

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/transactions \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
      "status": "CREATED",
      "type": "INCOMING",
      "source": {
        "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "currency": "USD"
      },
      "destination": {
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
        "currency": "EUR"
      },
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCustomerId": "18d3e5f7b4a9c2",
      "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
}

GET

transactions

List transactions

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/transactions \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
      "status": "CREATED",
      "type": "INCOMING",
      "source": {
        "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "currency": "USD"
      },
      "destination": {
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
        "currency": "EUR"
      },
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
      "platformCustomerId": "18d3e5f7b4a9c2",
      "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

Successful operation

data

object[]

required

List of transactions matching the criteria

Show child attributes

data.id

string

required

Unique identifier for the transaction

Example:

"Transaction:019542f5-b3e7-1d02-0000-000000000004"

data.status

enum<string>

required

Status of a payment transaction

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

REJECTED,

FAILED,

REFUNDED,

EXPIRED

data.type

enum<string>

required

Type of transaction (incoming payment or outgoing payment)

Available options:

INCOMING,

OUTGOING

data.source

Account Source · object

required

Source account details

Account Source
UMA Address Source

Show child attributes

data.source.accountId

string

required

Source account identifier

Example:

"InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"

data.source.currency

string

required

Currency code for the source account

Example:

"USD"

data.destination

Account Destination · object

required

Destination account details

Account Destination
UMA Address Destination

Show child attributes

data.destination.accountId

string

required

Destination account identifier

Example:

"ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"

data.destination.currency

string

required

Currency code for the destination account

Example:

"EUR"

data.customerId

string

required

System ID of the customer (sender for outgoing, recipient for incoming)

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

data.platformCustomerId

string

required

Platform-specific ID of the customer (sender for outgoing, recipient for incoming)

Example:

"18d3e5f7b4a9c2"

data.settledAt

string<date-time>

When the payment was or will be settled

Example:

"2025-08-15T14:30:00Z"

data.createdAt

string<date-time>

When the transaction was created

Example:

"2025-08-15T14:25:18Z"

data.updatedAt

string<date-time>

When the transaction was last updated

Example:

"2025-08-15T14:30:00Z"

data.description

string

Optional memo or description for the payment

Example:

"Payment for invoice #1234"

data.counterpartyInformation

object

Additional information about the counterparty, if available and relevant to the transaction and platform. Only applicable for transactions to/from UMA addresses.

Example:

{
  "FULL_NAME": "John Sender",
  "BIRTH_DATE": "1985-06-15",
  "NATIONALITY": "DE"
}

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)

Execute a quote Get transaction by ID

⌘I

Using the API

API documentation

List transactions

Authorizations

Query Parameters

Response