List transfer quotes

Retrieve a list of transfer quotes with optional filtering parameters. Returns all quotes that match the specified filters. If no filters are provided, returns all quotes (paginated).

GET /quotes

List transfer quotes

cURL

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

200

{
  "data": [
    {
      "id": "Quote:019542f5-b3e7-1d02-0000-000000000006",
      "status": "PENDING",
      "createdAt": "2025-10-03T12:00:00Z",
      "expiresAt": "2025-10-03T12:05:00Z",
      "source": {
        "sourceType": "ACCOUNT",
        "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
      },
      "destination": {
        "destinationType": "ACCOUNT",
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
      },
      "sendingCurrency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "receivingCurrency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "totalSendingAmount": 123010,
      "totalReceivingAmount": 1000,
      "exchangeRate": 123,
      "feesIncluded": 10,
      "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000005",
      "paymentInstructions": [
        {
          "accountType": "US_ACCOUNT",
          "accountNumber": "1234567890",
          "routingNumber": "021000021",
          "bankName": "Chase Bank",
          "referenceCode": "REF123456"
        },
        {
          "accountType": "SPARK_WALLET",
          "address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
          "invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
        }
      ],
      "rateDetails": {
        "counterpartyMultiplier": 1.08,
        "counterpartyFixedFee": 10,
        "gridApiMultiplier": 0.925,
        "gridApiFixedFee": 10,
        "gridApiVariableFeeRate": 0.003,
        "gridApiVariableFeeAmount": 30
      }
    }
  ],
  "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 sending customer ID

sendingAccountId · string

Filter by sending account ID

receivingAccountId · string

Filter by receiving account ID

sendingUmaAddress · string

Filter by sending UMA address

receivingUmaAddress · string

Filter by receiving UMA address

status · enum<string>

Filter by quote status

Available options: PENDING, PROCESSING, COMPLETED, FAILED, EXPIRED

createdAfter · string<date-time>

Filter quotes created after this timestamp (inclusive)

createdBefore · string<date-time>

Filter quotes created before this timestamp (inclusive)

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)

Response

200

application/json

Successful operation

data · object[] · required

List of quotes matching the criteria

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 quotes matching the criteria (excluding pagination)