LIlightsparkdev
Transactions

List transactions

Changed on

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

get/transactions

Request

  • Base URL
    https://api.uma.money/umaaas/2025-05-15
  • URL
    https://api.uma.money/umaaas/2025-05-15/transactions
  • Auth
    HTTP basic

Query parameters

userIdstring

Filter by system user ID

platformUserIdstring

Filter by platform-specific user ID

umaAddressstring

Filter by UMA address (either sender or receiver)

senderUmaAddressstring

Filter by sender UMA address

receiverUmaAddressstring

Filter by receiver UMA address

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

Status of a payment transaction

Filter by transaction status

type'INCOMING' | 'OUTGOING'

Type of transaction (incoming payment or outgoing payment)

Filter by transaction type

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)

Example response

{
  "data": [
    {
      "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
      "senderUmaAddress": "$sender@external.domain",
      "receiverUmaAddress": "$recipient@uma.domain",
      "userId": "User:019542f5-b3e7-1d02-0000-000000000001",
      "platformUserId": "18d3e5f7b4a9c2",
      "settledAt": "2023-08-15T14:30:00Z",
      "createdAt": "2023-08-15T14:25:18Z",
      "description": "Payment for invoice #1234",
      "counterpartyInformation": {
        "FULL_NAME": "John Sender",
        "BIRTH_DATE": "1985-06-15",
        "NATIONALITY": "DE"
      }
    }
  ]
}

Changes

  • 723ce326c29cRevision changes
    • info

      removed the INVALID_PAYREQ_RESPONSE enum value from the response property for the response status

    • info

      removed the LOOKUP_REQUEST_FAILED enum value from the response property for the response status

    • info

      removed the QUOTE_REQUEST_FAILED enum value from the response property for the response status