LIlightsparkdev
Transactions

List transactions

Changed on

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.

Card transactions are included and identified by type: CARD. In Sandbox this is how you discover a CardTransaction id after simulating an authorization — list the transactions, take the card transaction's id, and pass it as the cardTransactionId to the clearing and return simulate endpoints.

get/transactions

Request

  • Base URL
    https://api.lightspark.com/grid/2025-10-13
  • URL
    https://api.lightspark.com/grid/2025-10-13/transactions
  • Auth
    HTTP basic

Query parameters

customerIdstring

Filter by system customer ID. To filter to transactions made on behalf of the platform, specify the platform ID as the customer ID.

platformCustomerIdstring

Filter by platform-specific customer ID

accountIdentifierstring

Filter by account identifier (matches either sender or receiver)

senderAccountIdentifierstring

Filter by sender account identifier

receiverAccountIdentifierstring

Filter by receiver account identifier

status'CREATED' | 'PENDING' | 'PENDING_AUTHORIZATION' | 'PROCESSING' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'REFUNDED' | 'EXPIRED'

Status of a payment transaction.

StatusDescription
CREATEDInitial lookup has been created
PENDINGQuote has been created
PENDING_AUTHORIZATIONAwaiting Strong Customer Authentication. Only occurs for customers in a region where SCA is required (e.g. EU). The challenge is carried by the quote, not the transaction — fetch GET /quotes/{quoteId} using the transaction's quoteId, then authorize its scaChallenge via POST /quotes/{quoteId}/authorize.
PROCESSINGFunding has been received and payment initiated
COMPLETEDThe funds are where settlement put them. A return that takes them back moves the transaction to FAILED, and the returned side's railDetails shows RETURNED. A transaction stays COMPLETED through a return only when a later step that can't be undone already used the funds
REJECTEDReceiving institution or wallet rejected payment, payment has been refunded
FAILEDThe payment did not reach its destination, or the funds were sent back after it did. Not terminal for an incoming payment: a dishonored return restores the credit and moves it to COMPLETED. A returned payout stays FAILED, since it has already been refunded. Each step shows on the returned side's railDetails
REFUNDEDDeprecated. A refund is reported on the transaction's refund object, and the status stays FAILED
EXPIREDQuote has expired. Terminal

Filter by transaction status. Applies to payment transactions only: card transactions carry a card lifecycle status (see CardTransactionStatus) and are excluded from status-filtered queries. Combining status with type=CARD is rejected with a 400.

type'INCOMING' | 'OUTGOING' | 'CARD'

Type of transaction

Filter by transaction type

cardIdstring
Example:Card:019542f5-b3e7-1d02-0000-000000000010

Filter to card transactions made on a single card. Accepts a Card: LSID or a bare UUID. Only card transactions match, so this implies type=CARD and can be combined with customerId to list one card of a multi-card cardholder.

referencestring

Filter by reference

startDatestring date-time

Filter by start date (inclusive) in ISO 8601 format

endDatestring date-time

Filter by end date (inclusive) in ISO 8601 format

limitinteger

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

cursorstring

Cursor for pagination (returned from previous request)

sortOrder'asc' | 'desc'

Order to sort results in

Response

Successful operation

hasMoreboolean required

Indicates if more results are available beyond this page

nextCursorstring

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

totalCountinteger

Total number of transactions matching the criteria (excluding pagination)

Changes

  • d996ddfb9d2bRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 190120f7c3c4Revision changes
    • warning

      added the new PLATFORM_DECLINED enum value to the /// response property for the response status

    • warning

      added the new PLATFORM_UNAVAILABLE enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status