Skip to main content
GET
/
agents
/
me
/
quotes
/
{quoteId}
cURL
curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/quotes/{quoteId} \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "paymentRail": "ACH"
  },
  "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": [
    {
      "accountOrWalletInfo": {
        "accountType": "USD_ACCOUNT",
        "paymentRails": [
          "ACH",
          "WIRE"
        ],
        "accountNumber": "1234567890",
        "routingNumber": "021000021",
        "bankName": "Chase Bank",
        "reference": "UMA-Q12345-REF"
      },
      "instructionsNotes": "Include reference UMA-Q12345-REF in memo"
    },
    {
      "accountOrWalletInfo": {
        "accountType": "SPARK_WALLET",
        "assetType": "BTC",
        "address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
        "invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
      }
    }
  ],
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "rateDetails": {
    "counterpartyMultiplier": 1.08,
    "counterpartyFixedFee": 10,
    "gridApiMultiplier": 0.925,
    "gridApiFixedFee": 10,
    "gridApiVariableFeeRate": 0.003,
    "gridApiVariableFeeAmount": 30
  }
}

Documentation Index

Fetch the complete documentation index at: https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Path Parameters

​
quoteId
string
required

ID of the quote to retrieve

Response

Quote retrieved successfully

​
id
string
required

Unique identifier for this quote

Example:

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

​
status
enum<string>
required

Current status of the quote

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

"PENDING"

​
createdAt
string<date-time>
required

When this quote was created

Example:

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

​
expiresAt
string<date-time>
required

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

Example:

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

​
source
Account · object
required

Source account details

​
destination
Account · object
required

Destination account details

​
sendingCurrency
object
required

Currency for the sending amount

​
receivingCurrency
object
required

Currency for the receiving amount

​
totalSendingAmount
integer<int64>
required

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

Example:

123010

​
totalReceivingAmount
integer<int64>
required

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

Example:

1000

​
exchangeRate
number
required

Number of sending currency units per receiving currency unit.

​
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

​
transactionId
string
required

The ID of the transaction created from this quote.

Example:

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

​
paymentInstructions
object[]

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

Example:
[
  {
    "accountOrWalletInfo": {
      "accountType": "USD_ACCOUNT",
      "paymentRails": ["ACH", "WIRE"],
      "accountNumber": "1234567890",
      "routingNumber": "021000021",
      "bankName": "Chase Bank",
      "reference": "UMA-Q12345-REF"
    },
    "instructionsNotes": "Include reference UMA-Q12345-REF in memo"
  },
  {
    "accountOrWalletInfo": {
      "accountType": "SPARK_WALLET",
      "assetType": "BTC",
      "address": "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu",
      "invoice": "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
    }
  }
]
​
counterpartyInformation
object

Additional information about the counterparty, if available and required by the platform in their configuration.

Example:
{
  "FULL_NAME": "John Sender",
  "BIRTH_DATE": "1985-06-15",
  "NATIONALITY": "DE"
}
​
rateDetails
object

Details about the rate and fees for the transaction.