Lightspark Agent Operations API
Endpoints called by the agent itself using its own credentials (obtained via device code redemption). Scoped to the agent's associated customer — all requests automatically operate on behalf of that customer and are subject to the agent's policy. When an action requires approval, the resulting transaction enters a pending state and must be approved by the platform via `POST /transactions/{transactionId}/approve`.
Lightspark Agent Operations API is one of 23 APIs that Lightspark publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agent Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 15 operations across 13 paths, and defines 352 schemas. It is described by OpenAPI 3.2.0, at version 2025-10-13.
Requests are made against a single base URL, https://api.lightspark.com/grid/2025-10-13.
15 operations
13 paths
352 schemas
1 DELETE9 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Lightspark Agent Operations API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (AgentAuth).
An API key is passed in the header as X-Grid-Signature (WebhookSignature).
By default, every request must be authenticated.
BasicAuth— API token authentication using format :AgentAuth— Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}…WebhookSignature— Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature: 1. Get t…
Paths & Operations 15
Across 13 paths, the API surfaces 15 operations — 1 DELETE, 9 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Agent Operations 15
Endpoints called by the agent itself using its own credentials (obtained via device code redemption). Scoped to the agent's associated customer — all requests automatically operat…
GET
/agents/me
Get current agent
GET
/agents/me/transactions
List agent transactions
GET
/agents/me/transactions/{transactionId}
Get agent transaction by ID
POST
/agents/me/quotes
Create a transfer quote
GET
/agents/me/quotes/{quoteId}
Get agent quote by ID
POST
/agents/me/quotes/{quoteId}/execute
Execute a quote
GET
/agents/me/actions
List agent's own actions
GET
/agents/me/actions/{actionId}
Get an agent action
POST
/agents/me/transfer-in
Create a transfer-in
POST
/agents/me/transfer-out
Create a transfer-out
GET
/agents/me/internal-accounts
List agent's internal accounts
GET
/agents/me/external-accounts
List agent external accounts
POST
/agents/me/external-accounts
Add an external account
GET
/agents/me/external-accounts/{externalAccountId}
Get agent external account by ID
DELETE
/agents/me/external-accounts/{externalAccountId}
Delete agent external account
Schemas 352
The contract defines 352 schemas that model the data the API accepts and returns. The most detailed are CardTransaction (20 properties), Quote (18 properties), Transaction (14 properties), AgentAction (12 properties). Each schema is shown below with its type and property counts.
TransactionSourceType
string
Type of transaction source
VndAccountInfo
VndBeneficiary
object
8 properties
2 required
HkdAccountInfo
Transaction
object
14 properties
7 required
PkrAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
5 properties
2 required
PaymentNgnAccountInfo
PhpAccountInfoBase
object
3 properties
3 required
CnyAccountInfo
IncomingTransaction
RwfAccountInfoBase
object
3 properties
3 required
MwkExternalAccountCreateInfo
TransactionOneOf
PaymentMyrAccountInfo
JmdAccountInfoBase
object
5 properties
5 required
CardMerchant
object
3 properties
1 required
TzsExternalAccountInfo
LightningExternalAccountInfo
ExternalAccountListResponse
object
4 properties
2 required
CadExternalAccountInfo
SolanaWalletExternalAccountInfo
BaseWalletInfo
object
2 properties
2 required
UsdAccountInfo
PaymentBdtAccountInfo
AgentActionStatus
string
Status of an agent action. | Status | Description | |--------|-------------| | PENDINGAPPROVAL | Submitted by the agent, awaiting platform approval before exec…
SgdExternalAccountInfo
PaymentXofAccountInfo
PaymentGbpAccountInfo
CadBeneficiary
object
9 properties
2 required
UmaAddressTransactionSource
TransactionType
string
Type of transaction (incoming payment or outgoing payment)
BdtAccountInfo
PkrBeneficiary
object
8 properties
2 required
SparkWalletInfo
object
2 properties
2 required
TzsExternalAccountCreateInfo
EurAccountInfoBase
object
3 properties
2 required
Quote
object
18 properties
13 required
InternalAccountStatus
string
Status of a Grid internal account. The status determines whether the account can send or receive payments. - PENDING: The account is under review and is being…
PkrAccountInfo
QuoteLockSide
string
The side of the quote which should be locked and specified in the lockedCurrencyAmount. For example, if I want to send exactly $5 MXN from my wallet, I would s…
DkkExternalAccountInfo
XafAccountInfoBase
object
4 properties
4 required
PaymentTronWalletInfo
BaseDestination
object
1 property
1 required
PaymentPhpAccountInfo
CnyBeneficiary
object
8 properties
2 required
PaymentAedAccountInfo
RwfExternalAccountInfo
BrlAccountInfoBase
object
4 properties
4 required
KesAccountInfo
CopBeneficiary
object
10 properties
2 required
ExternalAccountReference
object
1 property
1 required
KesAccountInfoBase
object
3 properties
3 required
Error424
object
4 properties
3 required
ZarAccountInfoBase
object
3 properties
3 required
SwiftExternalAccountInfo
PaymentInstructions
object
3 properties
1 required
PaymentEmbeddedWalletInfo
Agent
object
A programmatic agent with scoped permissions and a spending policy, used to automate payment workflows.
9 properties
9 required
ZarAccountInfo
PaymentUgxAccountInfo
BwpExternalAccountCreateInfo
EurAccountInfo
UgxAccountInfo
XafExternalAccountInfo
Currency
object
4 properties
JmdBeneficiary
object
8 properties
4 required
HkdAccountInfoBase
object
4 properties
4 required
BaseTransactionDestination
object
2 properties
1 required
QuoteSourceType
string
Type of quote funding source
InternalAccount
object
10 properties
8 required
BasePaymentAccountInfo
object
1 property
1 required
ExternalAccount
SgdExternalAccountCreateInfo
AccountTransactionSource
InternalAccountListResponse
object
4 properties
2 required
CounterpartyInformation
object
Additional information about the counterparty, if available and relevant to the transaction and platform.
TransactionDirection
string
Whether the transaction credits (funds in) or debits (funds out) the customer's account. Independent of type: an incoming transaction is normally a CREDIT, but…
TransactionListResponse
object
4 properties
2 required
PaymentHtgAccountInfo
PolygonWalletInfo
object
2 properties
2 required
PurposeOfPayment
string
The purpose of the payment. This may be required when sending to certain geographies (e.g. India).
ZmwAccountInfoBase
object
3 properties
3 required
BaseExternalAccountInfo
object
1 property
1 required
AgentAction
object
An action submitted by an agent that may require platform approval before execution. All agent-initiated operations (quote execution, transfers) are represente…
12 properties
8 required
PaymentCopAccountInfo
CurrencyAmount
object
2 properties
2 required
OnChainTransaction
object
2 properties
2 required
GbpAccountInfoBase
object
3 properties
3 required
PhpBeneficiary
object
8 properties
2 required
BdtExternalAccountCreateInfo
TransferOutRequest
object
4 properties
2 required
ScaChallenge
object
A Strong Customer Authentication challenge that must be satisfied before a money-movement operation can complete. This object is only present when the customer…
7 properties
4 required
SgdAccountInfoBase
object
4 properties
3 required
RealtimeFundingTransactionSource
PaymentBwpAccountInfo
PaymentEthereumWalletInfo
GhsAccountInfo
AedExternalAccountCreateInfo
BaseTransactionSource
object
2 properties
1 required
Error412
object
4 properties
3 required
MyrExternalAccountInfo
InrBeneficiary
object
8 properties
2 required
XofExternalAccountInfo
AedBeneficiary
object
8 properties
3 required
PaymentJmdAccountInfo
ExternalAccountDestinationReference
object
2 properties
1 required
MwkAccountInfoBase
object
3 properties
3 required
Error400
object
4 properties
3 required
Error401
object
4 properties
3 required
UgxExternalAccountInfo
MxnExternalAccountCreateInfo
ZmwExternalAccountCreateInfo
EgpAccountInfo
Error409
object
4 properties
3 required
CnyAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
CopAccountInfo
TzsAccountInfoBase
object
3 properties
3 required
ExternalAccountType
string
Type of external account or wallet
AgentActionType
string
The type of action the agent is requesting. | Type | Description | |------|-------------| | EXECUTEQUOTE | Execute a cross-currency quote | | TRANSFEROUT | Tra…
ScaFactor
string
A Strong Customer Authentication factor. | Factor | Description | |--------|-------------| | SMSOTP | One-time code sent by SMS to the customer's verified phon…
ExternalAccountInfoOneOf
AgentPolicy
object
Policy governing what an agent can do, how it executes actions, and its spending boundaries.
5 properties
3 required
HtgExternalAccountCreateInfo
BwpBeneficiary
object
8 properties
2 required
PhpExternalAccountCreateInfo
PaymentSlvAccountInfo
SwiftExternalAccountCreateInfo
OutgoingRateDetails
object
Details about the rate and fees for an outgoing transaction or quote. Note: counterpartyFixedFee is denominated in the receiving currency, so its equivalent va…
6 properties
6 required
SlvExternalAccountCreateInfo
PaymentIdrAccountInfo
PaymentXafAccountInfo
GhsExternalAccountInfo
EgpExternalAccountCreateInfo
BwpAccountInfo
PaymentSolanaWalletInfo
MxnExternalAccountInfo
SlvExternalAccountInfo
HkdExternalAccountInfo
PaymentRail
string
The payment rail used for the transfer. Payment rails represent the underlying payment network or system used to move funds between accounts.
PaymentGtqAccountInfo
GtqExternalAccountInfo
AgentApprovalThresholds
object
Thresholds that force approval for high-value transactions, overriding the default execution mode. When a transaction is denominated in a different currency th…
2 properties
ThbExternalAccountInfo
SwiftBeneficiary
object
8 properties
2 required
PaymentUsdAccountInfo
InrAccountInfo
MwkBeneficiary
object
8 properties
2 required
PaymentEgpAccountInfo
PaymentInrAccountInfo
BaseQuoteSource
object
1 property
1 required
PhpAccountInfo
CopExternalAccountInfo
HtgBeneficiary
object
8 properties
2 required
CardTransaction
object
Parent transaction row for a card authorization and all of the pulls / settlements / refunds that reconcile against it. Child events are rolled up into the pul…
20 properties
12 required
AgentAccountRule
object
Per-account policy override that takes precedence over the agent's default policy for a specific account.
3 properties
1 required
GbpBeneficiary
object
8 properties
2 required
GtqBeneficiary
object
8 properties
4 required
RailSelectionMode
string
How the payment rail was chosen — MANUAL when the platform specified a paymentRail on the destination, AUTO when Lightspark selects it.
IncomingTransactionFailureReason
string
Reason for failure of an incoming transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, t…
TronWalletExternalAccountInfo
PaymentPkrAccountInfo
PaymentHkdAccountInfo
HtgAccountInfoBase
object
2 properties
2 required
AedAccountInfoBase
object
3 properties
2 required
EurExternalAccountCreateInfo
IdrAccountInfo
PaymentThbAccountInfo
MxnAccountInfo
GhsBeneficiary
object
8 properties
2 required
EgpAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankName, iban - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
AgentAccountRestrictions
object
Optional restrictions that limit the agent to specific accounts or override policy per account.
2 properties
ThbAccountInfoBase
object
4 properties
4 required
EthereumWalletInfo
object
2 properties
2 required
SparkWalletExternalAccountInfo
MwkAccountInfo
PkrExternalAccountInfo
UmaAddressTransactionDestination
CnyExternalAccountInfo
HtgAccountInfo
IdrExternalAccountInfo
SlvBeneficiary
object
8 properties
2 required
JmdAccountInfo
ZmwAccountInfo
PaymentBrlAccountInfo
PolygonWalletExternalAccountInfo
SlvAccountInfo
SgdAccountInfo
ThbAccountInfo
MxnAccountInfoBase
object
2 properties
2 required
PaymentKesAccountInfo
JmdExternalAccountInfo
CryptoNetwork
string
The blockchain network an on-chain transaction settled on. Whether this is the mainnet or a test network (e.g. Solana devnet) is determined by your platform's…
TransactionDestinationType
string
Type of transaction destination
PaymentSgdAccountInfo
LightningInfo
object
Lightning payment destination. Exactly one of invoice, bolt12, or lightningAddress must be provided.
4 properties
1 required
DestinationType
string
Type of payment destination
TzsAccountInfo
PaymentCadAccountInfo
UsdExternalAccountCreateInfo
ZarExternalAccountCreateInfo
IncomingRateDetails
object
Details about the rate and fees for an incoming transaction. Note: gridApiFixedFee is denominated in the receiving currency, so its equivalent value in the sen…
4 properties
4 required
TransactionStatus
string
Status of a payment transaction. | Status | Description | |--------|-------------| | CREATED | Initial lookup has been created | | PENDING | Quote has been cre…
CopAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankAccountType, bankName - MOBILEMONEY: bankName, phoneNumber
5 properties
2 required
EthereumWalletExternalAccountInfo
PaymentArsAccountInfo
RwfBeneficiary
object
8 properties
2 required
OutgoingTransaction
UsdBeneficiary
object
8 properties
2 required
AgentExecutionMode
string
Execution mode controlling whether agent actions require human approval. AUTO: The agent can execute actions autonomously without explicit approval. APPROVALRE…
Address
object
6 properties
3 required
EgpExternalAccountInfo
PaymentMwkAccountInfo
ExternalAccountCreateInfoOneOf
BwpExternalAccountInfo
InrAccountInfoBase
object
Required fields depend on the selected paymentRails: - NEFT: accountNumber, ifsc, rail - RTGS: accountNumber, ifsc, rail - UPI: vpa
6 properties
1 required
CardRefundSummary
object
2 properties
2 required
PaymentEurAccountInfo
PaymentVndAccountInfo
CadExternalAccountCreateInfo
ThbBeneficiary
object
8 properties
2 required
UgxAccountInfoBase
object
3 properties
3 required
XofExternalAccountCreateInfo
ThbExternalAccountCreateInfo
ZmwExternalAccountInfo
BeneficiaryVerifiedData
object
1 property
MxnBeneficiary
object
8 properties
2 required
IdrAccountInfoBase
object
5 properties
5 required
GbpAccountInfo
XofBeneficiary
object
8 properties
2 required
BwpAccountInfoBase
object
3 properties
3 required
GbpExternalAccountCreateInfo
VndExternalAccountCreateInfo
AccountTransactionDestination
BdtAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
6 properties
2 required
XafAccountInfo
ZmwBeneficiary
object
8 properties
2 required
NgnAccountInfo
UmaAddressDestination
PaymentBaseWalletInfo
DkkAccountInfoBase
object
3 properties
2 required
AccountDestination
IdrBeneficiary
object
8 properties
2 required
Error403
object
4 properties
3 required
BusinessBeneficiary
object
8 properties
2 required
SwiftAccountInfoBase
object
6 properties
4 required
MyrBeneficiary
object
8 properties
2 required
OutgoingTransactionStatus
string
Status of an outgoing payment transaction. | Status | Description | |--------|-------------| | PENDING | Quote is pending confirmation | | PENDINGAUTHORIZATION…
XofAccountInfo
PaymentCnyAccountInfo
ExternalAccountCreateRequest
MwkExternalAccountInfo
ZarBeneficiary
object
8 properties
2 required
PaymentLightningInvoiceInfo
KesExternalAccountInfo
GhsExternalAccountCreateInfo
CardTransactionStatus
string
Lifecycle status of a card transaction. | Status | Description | |--------|-------------| | AUTHORIZED | The auth has been approved and a hold placed on the fu…
SwiftAccountInfo
MyrAccountInfoBase
object
4 properties
4 required
CadAccountInfoBase
object
4 properties
4 required
AgentPermission
string
Permission granted to an agent that determines what actions it can perform. VIEWTRANSACTIONS: Can list and retrieve transactions and account balances. CREATETR…
PaymentAccountType
string
Type of payment account or wallet
GtqExternalAccountCreateInfo
SgdBeneficiary
object
8 properties
2 required
NgnExternalAccountInfo
HtgExternalAccountInfo
PaymentRwfAccountInfo
NgnAccountInfoBase
object
3 properties
3 required
BdtBeneficiary
object
8 properties
2 required
ExternalAccountStatus
string
Status of an external account
UsdAccountInfoBase
object
3 properties
3 required
InternalAccountReference
object
1 property
1 required
Refund
object
5 properties
3 required
XafExternalAccountCreateInfo
ZarExternalAccountInfo
PaymentMxnAccountInfo
IdrExternalAccountCreateInfo
RealtimeFundingQuoteSource
GtqAccountInfoBase
object
4 properties
4 required
QuoteSourceOneOf
GbpExternalAccountInfo
BeneficiaryVerificationStatus
string
The result of verifying the beneficiary name against the account holder name. | Status | Description | |--------|-------------| | MATCHED | The beneficiary nam…
PhpExternalAccountInfo
SolanaWalletInfo
object
2 properties
2 required
PaymentZmwAccountInfo
QuoteDestinationOneOf
BdtExternalAccountInfo
CardPullSummary
object
3 properties
2 required
PaymentPolygonWalletInfo
BaseWalletExternalAccountInfo
BrlAccountInfo
JmdExternalAccountCreateInfo
InternalAccountType
string
Classification of an internal account. - INTERNALFIAT: A Grid-managed fiat holding account (for example, the USD holding account used as the source for Payouts…
DkkExternalAccountCreateInfo
PaymentZarAccountInfo
EgpBeneficiary
object
8 properties
2 required
AgentTransferDetails
object
Details of a transfer-type agent action (TRANSFEROUT or TRANSFERIN).
4 properties
4 required
PaymentDkkAccountInfo
EurBeneficiary
object
8 properties
3 required
KesBeneficiary
object
8 properties
2 required
GtqAccountInfo
TzsBeneficiary
object
8 properties
2 required
DkkBeneficiary
object
8 properties
2 required
PaymentSwiftAccountInfo
UgxExternalAccountCreateInfo
InrExternalAccountInfo
EurExternalAccountInfo
VndAccountInfoBase
object
4 properties
4 required
XafBeneficiary
object
8 properties
2 required
CopExternalAccountCreateInfo
TransactionSourceOneOf
MyrAccountInfo
InrExternalAccountCreateInfo
QuoteRequest
object
11 properties
4 required
BrlExternalAccountInfo
RwfAccountInfo
PaymentTzsAccountInfo
Error404
object
4 properties
3 required
BrlBeneficiary
object
8 properties
2 required
DkkAccountInfo
UsdExternalAccountInfo
Error500
object
4 properties
3 required
TronWalletInfo
object
2 properties
2 required
PaymentGhsAccountInfo
AccountQuoteSource
AedExternalAccountInfo
NgnExternalAccountCreateInfo
AedAccountInfo
HkdExternalAccountCreateInfo
NgnBeneficiary
object
8 properties
2 required
MyrExternalAccountCreateInfo
AgentUsage
object
Real-time counters tracking the agent's spending and transaction activity against its policy limits.
5 properties
3 required
KesExternalAccountCreateInfo
AgentSpendingLimits
object
Spending limits that cap the agent's transaction amounts and frequency. All amount fields are integers in the smallest unit of the specified currency. When a t…
5 properties
2 required
PkrExternalAccountCreateInfo
UgxBeneficiary
object
8 properties
2 required
TransferInRequest
object
3 properties
2 required
HkdBeneficiary
object
8 properties
2 required
XofAccountInfoBase
object
4 properties
4 required
RwfExternalAccountCreateInfo
CnyExternalAccountCreateInfo
CadAccountInfo
ReconciliationInstructions
object
Instructions for reconciling a payment with this transaction. For the on-chain transaction to or from an external crypto wallet that is the transaction's own s…
2 properties
SlvAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankAccountType, accountNumber - MOBILEMONEY: phoneNumber
5 properties
1 required
CardSettlementSummary
object
2 properties
2 required
PaymentSparkWalletInfo
VndExternalAccountInfo
BrlExternalAccountCreateInfo
GhsAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
AgentActionListResponse
object
4 properties
2 required
TransactionDestinationOneOf
OutgoingTransactionFailureReason
string
Reason for failure of an outgoing transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, t…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lightspark 12
Other APIs Lightspark publishes across the network.
Lightspark Agent Management API
Lightspark API Tokens API
Lightspark Available UMA Providers API
Lightspark Cards API
Lightspark Contact Verification API
Lightspark Cross-Currency Transfers API
Lightspark Customers API
Lightspark Discoveries API
Lightspark Documents API
Lightspark Embedded Wallet Auth API
Lightspark Exchange Rates API
Lightspark External Accounts API
#Agent Operations
Where this information came from
This is an independent, third-party profile of Lightspark Agent Operations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.