Get an agent deposit

Retrieve a deposit created by the authenticated agent. Requires the RECEIVE_FUNDS permission in the agent’s policy.

GET /agents/me/deposits/{depositId}

Get an agent deposit

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/deposits/{depositId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "AgentDeposit:019542f5-b3e7-1d02-0000-000000000001",
  "status": "PENDING",
  "sourceNetwork": "LIGHTNING",
  "sourceCurrency": "BTC",
  "destinationInternalAccountId": "InternalAccount:019542f5-b3e7-1d02-0000-000000000002",
  "destinationCurrency": "USDB",
  "targetType": "LIGHTNING_INVOICE",
  "target": "lnbc1pndepositpp5...",
  "createdAt": "2026-10-09T18:00:00Z",
  "updatedAt": "2026-10-09T18:01:00Z",
  "sourceAmount": 31500,
  "estimatedReceiveAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
  "paymentLinks": {
    "cashApp": "https://cash.app/launch/lightning/lnbc1pndepositpp5...",
    "shortUrl": "https://link.grid.money/deposit/Ab3dE7"
  },
  "expiresAt": "2026-10-09T18:05:00Z",
  "paidAfterExpiry": false
}

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/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

depositId · string · required

System-generated unique deposit identifier

Response

200

application/json

Successful operation

A deposit that converts funds from an external network into an internal account belonging to the agent's customer. A deposit reported FAILED or EXPIRED can still become COMPLETED when the funds arrive late; the platform then receives the INCOMING_PAYMENT webhook for the deposit's transaction again, now COMPLETED.

id · string · required

System-generated unique deposit identifier.

Example:

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

status · enum<string> · required

Current processing state of the deposit.

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

sourceNetwork · enum<string> · required

Network from which the customer sends the deposit.

Available options: LIGHTNING, BASE, ETHEREUM, SOLANA, POLYGON, ARBITRUM, TRON

sourceCurrency · string · required

Currency or asset the customer sends.

Example:

"BTC"

destinationInternalAccountId · string · required

Internal account that receives the converted deposit.

Example:

"InternalAccount:019542f5-b3e7-1d02-0000-000000000002"

destinationCurrency · string · required

Currency credited to the destination internal account.

Example:

"USDB"

targetType · enum<string> · required

Whether target is a Lightning invoice or chain address.

Available options: LIGHTNING_INVOICE, CHAIN_ADDRESS

target · string · required

BOLT11 invoice when targetType is LIGHTNING_INVOICE; otherwise the address on sourceNetwork to which the customer sends funds.

Example:

"lnbc1pndepositpp5..."

createdAt · string<date-time> · required

Time when the deposit was created.

Example:

"2026-10-09T18:00:00Z"

updatedAt · string<date-time> · required

Time when the deposit was last updated.

Example:

"2026-10-09T18:01:00Z"

sourceAmount · integer<int64>

Amount to send in the smallest unit of sourceCurrency, when the deposit quote fixes the source amount.

Example:

31500

estimatedReceiveAmount · object

Estimated amount credited to the destination internal account after fees, denominated in the destination asset. Present for LIGHTNING deposits.

Show child attributes

quoteId · string

The quote that funds the deposit. The transaction that pays the deposit carries the same quoteId, so a payment can be matched to its deposit.

Example:

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

paymentLinks · object

Payment links for a LIGHTNING deposit. Absent for chain deposits.

Show child attributes

expiresAt · string<date-time> | null

When the deposit must be paid by: the invoice's expiry for LIGHTNING, or the quote's for a chain deposit Grid funds through a quote. Omitted or null for standing chain deposit addresses, which do not expire.

Example:

"2026-10-09T18:05:00Z"

paidAfterExpiry · boolean

Whether a payment for this deposit arrived after expiresAt, so only a deposit with an expiresAt can have one. A chain payment that arrives after its quote expired is not converted: the deposit stays EXPIRED and Lightspark is alerted to recover the funds by hand, so the payment must not be sent again. Absent or false while no late payment is known.

Example:

false