Get an agent deposit
Retrieve a deposit created by the authenticated agent. Requires the RECEIVE_FUNDS permission in the agent’s policy.
Authorizations
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
System-generated unique deposit identifier
Response
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.
System-generated unique deposit identifier.
"AgentDeposit:019542f5-b3e7-1d02-0000-000000000001"
Current processing state of the deposit.
PENDING, PROCESSING, COMPLETED, EXPIRED, FAILED, REFUNDED Network from which the customer sends the deposit.
LIGHTNING, BASE, ETHEREUM, SOLANA, POLYGON, ARBITRUM, TRON Currency or asset the customer sends.
"BTC"
Internal account that receives the converted deposit.
"InternalAccount:019542f5-b3e7-1d02-0000-000000000002"
Currency credited to the destination internal account.
"USDB"
Whether target is a Lightning invoice or chain address.
LIGHTNING_INVOICE, CHAIN_ADDRESS BOLT11 invoice when targetType is LIGHTNING_INVOICE; otherwise the address on sourceNetwork to which the customer sends funds.
"lnbc1pndepositpp5..."
Time when the deposit was created.
"2026-10-09T18:00:00Z"
Time when the deposit was last updated.
"2026-10-09T18:01:00Z"
Amount to send in the smallest unit of sourceCurrency, when the deposit quote fixes the source amount.
31500
Estimated amount credited to the destination internal account after fees, denominated in the destination asset. Present for LIGHTNING deposits.
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.
"Quote:019542f5-b3e7-1d02-0000-000000000006"
Payment links for a LIGHTNING deposit. Absent for chain deposits.
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.
"2026-10-09T18:05:00Z"
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.
false