List transfer quotes

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

{
  "data": [
    {
      "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
      "status": "PENDING",
      "createdAt": "2025-10-03T12:00:00Z",
      "expiresAt": "2025-10-03T12:05:00Z",
      "source": {
        "accountId": "InternalAccount:85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "currency": "USD"
      },
      "destination": {
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
        "currency": "EUR"
      },
      "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"
        }
      ],
      "originalQuoteId": "Quote:019542f5-b3e7-1d02-0000-000000000001",
      "rateDetails": {
        "counterpartyMultiplier": 1.08,
        "counterpartyFixedFee": 10,
        "gridApiMultiplier": 0.925,
        "gridApiFixedFee": 10,
        "gridApiVariableFeeRate": 0.003,
        "gridApiVariableFeeAmount": 30
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "totalCount": 123
}

GET

quotes

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

{
  "data": [
    {
      "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
      "status": "PENDING",
      "createdAt": "2025-10-03T12:00:00Z",
      "expiresAt": "2025-10-03T12:05:00Z",
      "source": {
        "accountId": "InternalAccount:85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
        "currency": "USD"
      },
      "destination": {
        "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
        "currency": "EUR"
      },
      "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"
        }
      ],
      "originalQuoteId": "Quote:019542f5-b3e7-1d02-0000-000000000001",
      "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

Successful operation

data

object[]

required

List of quotes matching the criteria

Show child attributes

data.quoteId

string

required

Unique identifier for this quote

Example:

"Quote:019542f5-b3e7-1d02-0000-000000000006"

data.status

enum<string>

required

Current status of the quote

Available options:

PENDING,

PROCESSING,

COMPLETED,

FAILED,

EXPIRED

Example:

"PENDING"

data.createdAt

string<date-time>

required

When this quote was created

Example:

"2025-10-03T12:00:00Z"

data.expiresAt

string<date-time>

required

When this quote expires (typically 1-5 minutes after creation)

Example:

"2025-10-03T12:05:00Z"

data.source

Account · object

required

Source account details

Account
Real-time funding

Show child attributes

data.source.accountId

string

required

Source account identifier

Example:

"InternalAccount:85dcbd6-dced-4ec4-b756-3c3a9ea3d965"

data.source.currency

string

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

Currency code for the destination account

Example:

"EUR"

data.sendingCurrency

object

required

Currency for the sending amount

Show child attributes

data.sendingCurrency.code

string

Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)

Example:

"USD"

data.sendingCurrency.name

string

Full name of the currency

Example:

"United States Dollar"

data.sendingCurrency.symbol

string

Symbol of the currency

Example:

"$"

data.sendingCurrency.decimals

integer

Number of decimal places for the currency

Required range: x >= 0

Example:

2

data.receivingCurrency

object

required

Currency for the receiving amount

Show child attributes

data.receivingCurrency.code

string

Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)

Example:

"USD"

data.receivingCurrency.name

string

Full name of the currency

Example:

"United States Dollar"

data.receivingCurrency.symbol

string

Symbol of the currency

Example:

"$"

data.receivingCurrency.decimals

integer

Number of decimal places for the currency

Required range: x >= 0

Example:

2

data.totalSendingAmount

integer<int64>

required

The total amount that will be sent in the smallest unit of the sending currency (eg. cents).

Example:

123010

data.totalReceivingAmount

integer<int64>

required

The total amount that will be received in the smallest unit of the receiving currency (eg. cents).

Example:

1000

data.exchangeRate

number

required

Number of sending currency units per receiving currency unit.

data.feesIncluded

integer<int64>

required

The fees associated with the quote in the smallest unit of the sending currency (eg. cents).

Required range: x >= 0

Example:

10

data.transactionId

string

required

The ID of the transaction created from this quote.

Example:

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

data.paymentInstructions

object[]

Payment instructions for executing the payment. This is not required when using an internal account source.

Show child attributes

data.paymentInstructions.accountOrWalletInfo

CLABE Account · object

required

CLABE Account
US Bank Account
PIX Account
IBAN Account
FBO Account
UPI Account
Spark Wallet
Lightning Invoice
Solana Wallet
Tron Wallet
Polygon Wallet
Base Wallet

Show child attributes

data.paymentInstructions.accountOrWalletInfo.accountType

enum<string>

required

Type of account or wallet information

Available options:

CLABE

Example:

"CLABE"

data.paymentInstructions.accountOrWalletInfo.clabeNumber

string

required

18-digit CLABE number (Mexican banking standard)

Required string length: 18

Example:

"123456789012345678"

data.paymentInstructions.accountOrWalletInfo.reference

string

required

Unique reference code that must be included with the payment to properly credit it

Example:

"UMA-Q12345-REF"

data.paymentInstructions.instructionsNotes

string

Additional human-readable instructions for making the payment

Example:

"Please ensure the reference code is included in the payment memo/description field"

Example:

[
  {
    "accountType": "US_ACCOUNT",
    "accountNumber": "1234567890",
    "routingNumber": "021000021",
    "bankName": "Chase Bank",
    "referenceCode": "REF123456"
  },
  {
    "accountType": "SPARK_WALLET",
    "address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
    "invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
  }
]

data.originalQuoteId

string

ID of the quote that is being retried

Example:

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

data.rateDetails

object

Details about the rate and fees for the transaction.

Show child attributes

data.rateDetails.counterpartyMultiplier

number<double>

required

The underlying multiplier from mSATs to the receiving currency as returned by the counterparty institution.

Example:

1.08

data.rateDetails.counterpartyFixedFee

integer<int64>

required

The fixed fee charged by the counterparty institution to execute the quote in the smallest unit of the receiving currency (eg. cents).

Required range: x >= 0

Example:

10

data.rateDetails.gridApiMultiplier

number<double>

required

The underlying multiplier from the sending currency to mSATS, including variable fees.

Example:

0.925

data.rateDetails.gridApiFixedFee

integer<int64>

required

The fixed fee charged by the Grid product to execute the quote in the smallest unit of the sending currency (eg. cents).

Required range: x >= 0

Example:

10

data.rateDetails.gridApiVariableFeeRate

number<double>

required

The variable fee rate charged by the Grid product to execute the quote as a percentage of the sending currency amount.

Example:

0.003

data.rateDetails.gridApiVariableFeeAmount

number<int64>

required

The variable fee amount charged by the Grid product to execute the quote in the smallest unit of the sending currency (eg. cents). This is the sending amount times gridApiVariableFeeRate.

Required range: x >= 0

Example:

30

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)

Get quote by ID Create a transfer quote

⌘I

Using the API

API documentation

List transfer quotes

Authorizations

Query Parameters

Response