--- title: "List transfer quotes" method: GET path: "/quotes" tags: ["Cross-Currency Transfers"] --- # List transfer quotes `GET /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). ## Query parameters - `customerId` string - `sendingAccountId` string - `receivingAccountId` string - `sendingUmaAddress` string - `receivingUmaAddress` string - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'EXPIRED' - `createdAfter` string, date-time - `createdBefore` string, date-time - `limit` integer - `cursor` string ## Response `200` Successful operation - object - `data` Quote[], required — List of quotes matching the criteria - `id` string, required — Unique identifier for this quote - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'EXPIRED', required — Current status of the quote - `createdAt` string, date-time, required — When this quote was created - `expiresAt` string, date-time, required — When this quote expires (typically 1-5 minutes after creation) - `source` union, required - AccountQuoteSource — Source account details - `sourceType` 'ACCOUNT', required - `accountId` string, required — Source account identifier - `customerId` string — Required when funding from an FBO account to identify the customer on whose behalf the transaction is being initiated. Otherwise, will default to the customerId of the account owner. - RealtimeFundingQuoteSource — Fund the quote using a real-time funding source (RTP, SEPA Instant, Spark, Stables, etc.). This will require manual just-in-time funding using `paymentInstructions` in the response. Because quotes expire quickly, this option is only valid for instant payment methods. Do not try to fund a quote with a non-instant payment method (ACH, etc.). - `sourceType` 'REALTIME_FUNDING', required - `customerId` string — Source customer ID. If this transaction is being initiated on behalf of a customer, this is required. If customerId is not provided, the quote will be created on behalf of the platform itself. - `currency` string, required — Currency code for the funding source. See [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails) for the full list of supported fiat and crypto currencies. - `destination` union, required - AccountDestination — Destination account details - `destinationType` 'ACCOUNT', required - `accountId` string, required — Destination account identifier - UmaAddressDestination — UMA address destination details - `destinationType` 'UMA_ADDRESS', required - `umaAddress` string, required — UMA address of the recipient - `counterpartyInformation` object — Information about the recipient, as required by the platform in their configuration. - `currency` string — Currency code for the destination. See [Supported Currencies](https://grid.lightspark.com/platform-overview/core-concepts/currencies-and-rails) for the full list of supported fiat and crypto currencies. - ExternalAccountDetailsDestination — A convenient destination option which adds the external account and creates the quote in one step rather than first needing to call /external-accounts to add the account. Useful for one-off payments to some destination. See the external accounts endpoints for test values in sandbox mode. - `destinationType` 'EXTERNAL_ACCOUNT_DETAILS', required - `externalAccountDetails` ExternalAccountCreateRequest, required - `customerId` string — The ID of the customer for whom to create the external account. If not provided, the external account will be created on behalf of the platform. - `currency` string, required — The ISO 4217 currency code - `platformAccountId` string — Your platform's identifier for the account in your system. This can be used to reference the account by your own identifier. - `defaultUmaDepositAccount` boolean — Whether to set the external account as the default UMA deposit account. When set to true, incoming payments to this customer's UMA address will be automatically deposited into this external account. False if not provided. Note that only one external account can be set as the default UMA deposit account for a customer, so if there is already a default UMA deposit account, this will override the existing default UMA deposit account. If there is no default UMA deposit account, incoming UMA payments will be deposited into the primary internal account for the customer. - `accountInfo` union, required - BrlExternalAccountInfo - … - CadExternalAccountInfo - … - DkkExternalAccountInfo - … - EurExternalAccountInfo - … - GbpExternalAccountInfo - … - HkdExternalAccountInfo - … - IdrExternalAccountInfo - … - InrExternalAccountInfo - … - KesExternalAccountInfo - … - MxnExternalAccountInfo - … - MyrExternalAccountInfo - … - NgnExternalAccountInfo - … - PhpExternalAccountInfo - … - RwfExternalAccountInfo - … - SgdExternalAccountInfo - … - ThbExternalAccountInfo - … - TzsExternalAccountInfo - … - UsdExternalAccountInfo - … - VndExternalAccountInfo - … - ZarExternalAccountInfo - … - ZmwExternalAccountInfo - … - SparkWalletExternalAccountInfo - … - LightningExternalAccountInfo — Lightning payment destination. Exactly one of `invoice`, `bolt12`, or `lightningAddress` must be provided. - … - SolanaWalletExternalAccountInfo - … - TronWalletExternalAccountInfo - … - PolygonWalletExternalAccountInfo - … - BaseWalletExternalAccountInfo - … - `sendingCurrency` Currency, required - `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.) - `name` string — Full name of the currency - `symbol` string — Symbol of the currency - `decimals` integer — Number of decimal places for the currency - `receivingCurrency` Currency, required - `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.) - `name` string — Full name of the currency - `symbol` string — Symbol of the currency - `decimals` integer — Number of decimal places for the currency - `totalSendingAmount` integer, required — The total amount that will be sent in the smallest unit of the sending currency (eg. cents). - `totalReceivingAmount` integer, required — The total amount that will be received in the smallest unit of the receiving currency (eg. cents). - `exchangeRate` number, required — Number of sending currency units per receiving currency unit. - `feesIncluded` integer, required — The fees associated with the quote in the smallest unit of the sending currency (eg. cents). - `paymentInstructions` PaymentInstructions[] — Payment instructions for executing the payment. This is not required when using an internal account source. - `instructionsNotes` string — Additional human-readable instructions for making the payment - `isPlatformAccount` boolean — Indicates whether the account is a platform account or a customer account. - `accountOrWalletInfo` union, required - PaymentUsdAccountInfo - `accountType` 'USD_ACCOUNT', required - `paymentRails` string[], required - `accountNumber` string, required — The account number of the bank - `routingNumber` string, required — The routing number of the bank - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentBrlAccountInfo - `accountType` 'BRL_ACCOUNT', required - `paymentRails` string[], required - `pixKey` string, required — The PIX key of the bank - `pixKeyType` string, required — The type of PIX key of the bank - `taxId` string, required — The tax ID of the bank account - PaymentMxnAccountInfo - `accountType` 'MXN_ACCOUNT', required - `paymentRails` string[], required - `clabeNumber` string, required — The CLABE number of the bank - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentDkkAccountInfo - `accountType` 'DKK_ACCOUNT', required - `paymentRails` string[], required - `iban` string, required — The IBAN of the bank - `swiftBic` string — The SWIFT BIC of the bank - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentEurAccountInfo - `accountType` 'EUR_ACCOUNT', required - `paymentRails` string[], required - `iban` string, required — The IBAN of the bank - `swiftBic` string — The SWIFT BIC of the bank - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentInrAccountInfo - `accountType` 'INR_ACCOUNT', required - `paymentRails` string[], required - `vpa` string, required — The VPA of the bank - PaymentNgnAccountInfo - `accountType` 'NGN_ACCOUNT', required - `paymentRails` string[], required - `accountNumber` string, required — Nigerian bank account number - `bankName` string, required — Name of the bank - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentCadAccountInfo - `accountType` 'CAD_ACCOUNT', required - `paymentRails` string[], required - `bankCode` string, required — Canadian financial institution number (3 digits) - `branchCode` string, required — Transit number identifying the branch (5 digits) - `accountNumber` string, required — Bank account number (7-12 digits) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentGbpAccountInfo - `accountType` 'GBP_ACCOUNT', required - `paymentRails` string[], required - `sortCode` string, required — UK bank sort code (6 digits, may include hyphens) - `accountNumber` string, required — UK bank account number (8 digits) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentHkdAccountInfo - `accountType` 'HKD_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the bank - `accountNumber` string, required — Hong Kong bank account number - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentIdrAccountInfo - `accountType` 'IDR_ACCOUNT', required - `paymentRails` string[], required - `accountNumber` string, required — Indonesian bank account number - `bankName` string, required — Name of the bank - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `phoneNumber` string, required — Indonesian phone number for e-wallet payments - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentMyrAccountInfo - `accountType` 'MYR_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the bank - `accountNumber` string, required — Malaysian bank account number - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentPhpAccountInfo - `accountType` 'PHP_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the beneficiary's bank - `accountNumber` string, required — Bank account number - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentSgdAccountInfo - `accountType` 'SGD_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the beneficiary's bank - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `accountNumber` string, required — Bank account number - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentThbAccountInfo - `accountType` 'THB_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the bank - `accountNumber` string, required — Thai bank account number - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentVndAccountInfo - `accountType` 'VND_ACCOUNT', required - `paymentRails` string[], required - `bankName` string, required — Name of the bank - `accountNumber` string, required — Vietnamese bank account number - `swiftCode` string, required — SWIFT/BIC code (8 or 11 characters) - `reference` string, required — Unique reference code that must be included with the payment to properly credit it - PaymentSparkWalletInfo - `accountType` 'SPARK_WALLET', required - `address` string, required — Spark wallet address - `assetType` 'BTC' | 'USDB', required — Type of asset - `invoice` string — Invoice for the payment - PaymentLightningInvoiceInfo - `accountType` 'LIGHTNING' - `invoice` string, required — Invoice for the payment - PaymentSolanaWalletInfo - `accountType` 'SOLANA_WALLET', required - `address` string, required — Solana wallet address - `assetType` 'USDC' | 'USDT' — Type of asset - PaymentTronWalletInfo - `accountType` 'TRON_WALLET', required - `address` string, required — Tron wallet address - `assetType` 'USDT' — Type of asset - PaymentPolygonWalletInfo - `accountType` 'POLYGON_WALLET', required - `address` string, required — Polygon eth wallet address - `assetType` 'USDC' — Type of asset - PaymentBaseWalletInfo - `accountType` 'BASE_WALLET', required - `address` string, required — Base eth wallet address - `assetType` 'USDC' — Type of asset - `transactionId` string, required — The ID of the transaction created from this quote. - `rateDetails` OutgoingRateDetails — Details about the rate and fees for an outgoing transaction or quote. - `counterpartyMultiplier` number, double, required — The underlying multiplier from mSATs to the receiving currency as returned by the counterparty institution. - `counterpartyFixedFee` integer, required — The fixed fee charged by the counterparty institution to execute the quote in the smallest unit of the receiving currency (eg. cents). - `gridApiMultiplier` number, double, required — The underlying multiplier from the sending currency to mSATS, including variable fees. - `gridApiFixedFee` integer, required — The fixed fee charged by the Grid product to execute the quote in the smallest unit of the sending currency (eg. cents). - `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. - `gridApiVariableFeeAmount` number, 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. - `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) ## Other responses - `400` — Bad request - Invalid parameters - `401` — Unauthorized - `500` — Internal service error ## Changes - **2026-03-03** `efe0d983985f` — 38 breaking, 32 info - the response's body type/format changed from ``/`` to `object`/`` for status `400` - the response's body type/format changed from ``/`` to `object`/`` for status `401` - the response's body type/format changed from ``/`` to `object`/`` for status `500` - added `#/components/schemas/KesExternalAccountInfo, #/components/schemas/RwfExternalAccountInfo, #/components/schemas/TzsExternalAccountInfo, #/components/schemas/ZarExternalAccountInfo, #/components/schemas/ZmwExternalAccountInfo` to the `data/items/destination/oneOf[subschema #3: External Account Details]/allOf[subschema #2]/externalAccountDetails/allOf[subschema #1]/accountInfo` response property `oneOf` list for the response status `200` - …66 more - …earlier changes not shown [Full history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/quotes/get.md) --- [API](https://skmtc.dev/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.dev/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/revisions/efe0d983985f/schema)