Lightspark Webhooks API
Webhook endpoints and configuration for receiving notifications
Lightspark Webhooks API is one of 23 APIs that Lightspark publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 0 operations across 0 paths, and defines 245 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.
0 operations
0 paths
245 schemas
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Lightspark Webhooks 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…
Schemas 245
The contract defines 245 schemas that model the data the API accepts and returns. The most detailed are CardTransaction (20 properties), BusinessInfoUpdate (19 properties), BusinessInfoResponse (19 properties), Quote (18 properties). Each schema is shown below with its type and property counts.
Quote
object
18 properties
13 required
BulkCustomerImportJob
object
5 properties
3 required
Refund
object
5 properties
3 required
InternalAccountStatusWebhook
BasePaymentAccountInfo
object
1 property
1 required
VerificationErrorType
string
Type of verification error. The category-specific MISSINGDOCUMENT types indicate which document category is needed. Document quality types (POORQUALITYDOCUMENT…
QuoteDestinationOneOf
BdtAccountInfo
PhpAccountInfo
XofAccountInfoBase
object
4 properties
4 required
PaymentEthereumWalletInfo
HkdAccountInfo
PaymentUsdAccountInfo
PaymentCadAccountInfo
PaymentGhsAccountInfo
TransactionType
string
Type of transaction (incoming payment or outgoing payment)
PaymentEmbeddedWalletInfo
DocumentType
string
Type of identity or business verification document. Document types are grouped by verification category: Identity — PASSPORT, DRIVERSLICENSE, NATIONALID Busine…
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
UgxAccountInfo
MyrAccountInfoBase
object
4 properties
4 required
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…
IncomingPaymentWebhookResponse
object
1 property
TransactionOneOf
HkdAccountInfoBase
object
4 properties
4 required
PaymentUgxAccountInfo
UsdAccountInfoBase
object
3 properties
3 required
PaymentBaseWalletInfo
CounterpartyFieldDefinition
object
2 properties
2 required
BusinessCustomer
EgpAccountInfo
AccountTransactionSource
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…
IdentificationType
string
Type of tax identification
GtqAccountInfo
BaseTransactionSource
object
2 properties
1 required
IdrAccountInfoBase
object
5 properties
5 required
BaseWebhook
object
3 properties
3 required
JmdAccountInfo
AedAccountInfoBase
object
3 properties
2 required
PaymentBrlAccountInfo
PaymentHkdAccountInfo
PaymentInrAccountInfo
CardRefundSummary
object
2 properties
2 required
NgnAccountInfo
BwpAccountInfo
IncomingPaymentWebhookData
Customer
object
12 properties
3 required
GbpAccountInfoBase
object
3 properties
3 required
PolygonWalletInfo
object
2 properties
2 required
MxnAccountInfo
BeneficialOwner
object
8 properties
7 required
RailSelectionMode
string
How the payment rail was chosen — MANUAL when the platform specified a paymentRail on the destination, AUTO when Lightspark selects it.
IndividualCustomerFields
object
6 properties
1 required
Error409
object
4 properties
3 required
CardStateReason
string
Reason a card reached a terminal or non-active state. Present on CLOSED cards, and on cards that fail provisioning before reaching ACTIVE. | Reason | Descripti…
CustomerWebhook
CardBrand
string
Card network brand. Read-only — determined by Grid when the card is provisioned with the issuer.
CardStateChangeWebhook
KycStatus
string
The current KYC status of a customer. HOLD means the customer is placed on hold and may be required to update or provide more information.
BulkCustomerImportErrorEntry
VndAccountInfoBase
object
4 properties
4 required
TransactionSourceOneOf
PaymentSwiftAccountInfo
ContactVerification
object
Email and/or phone verification state for the customer. This object is only present when the customer's regulatory jurisdiction requires contact verification (…
2 properties
BusinessType
string
The high-level industry category of the business
AccountDestination
RealtimeFundingTransactionSource
GridError
object
3 properties
IncomingPaymentWebhookUnprocessableResponse
PaymentAedAccountInfo
GhsAccountInfo
PaymentZarAccountInfo
BaseQuoteSource
object
1 property
1 required
VndAccountInfo
HtgAccountInfoBase
object
2 properties
2 required
PaymentJmdAccountInfo
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…
AccountTransactionDestination
MxnAccountInfoBase
object
2 properties
2 required
PaymentMwkAccountInfo
PaymentIdrAccountInfo
BusinessInfoResponse
object
Business information returned on a customer. taxId and incorporatedOn are required on creation but may be absent on legacy customers that pre-date the requirem…
19 properties
1 required
KesAccountInfo
PaymentArsAccountInfo
TransactionDestinationType
string
Type of transaction destination
PaymentBwpAccountInfo
CardPullSummary
object
3 properties
2 required
KybStatus
string
The current KYB status of a business customer. HOLD means the customer is placed on hold and may be required to update or provide more information.
QuoteSourceOneOf
SlvAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankAccountType, accountNumber - MOBILEMONEY: phoneNumber
5 properties
1 required
JmdAccountInfoBase
object
5 properties
5 required
PaymentEgpAccountInfo
GhsAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
SwiftAccountInfoBase
object
6 properties
4 required
DkkAccountInfoBase
object
3 properties
2 required
PaymentRail
string
The payment rail used for the transfer. Payment rails represent the underlying payment network or system used to move funds between accounts.
EthereumWalletInfo
object
2 properties
2 required
OutgoingTransaction
PaymentTzsAccountInfo
PaymentVndAccountInfo
TzsAccountInfo
SgdAccountInfo
CadAccountInfoBase
object
4 properties
4 required
BeneficialOwnerPersonalInfo
object
11 properties
7 required
IncomingTransaction
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…
InrAccountInfo
PaymentCnyAccountInfo
PaymentThbAccountInfo
PaymentPkrAccountInfo
PurposeOfAccount
string
The intended purpose for using the Grid account
VerificationError
object
5 properties
3 required
PaymentSparkWalletInfo
QuoteSourceType
string
Type of quote funding source
AgentTransferDetails
object
Details of a transfer-type agent action (TRANSFEROUT or TRANSFERIN).
4 properties
4 required
DestinationType
string
Type of payment destination
RealtimeFundingQuoteSource
UgxAccountInfoBase
object
3 properties
3 required
PaymentHtgAccountInfo
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
ThbAccountInfoBase
object
4 properties
4 required
EurAccountInfo
AgentActionType
string
The type of action the agent is requesting. | Type | Description | |------|-------------| | EXECUTEQUOTE | Execute a cross-currency quote | | TRANSFEROUT | Tra…
IncomingPaymentWebhookForbiddenResponse
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…
ContactVerificationStatus
string
Status of an individual contact-verification channel (email or phone). PENDING means verification is required but not yet completed; VERIFIED means the channel…
AgentActionStatus
string
Status of an agent action. | Status | Description | |--------|-------------| | PENDINGAPPROVAL | Submitted by the agent, awaiting platform approval before exec…
PaymentAccountType
string
Type of payment account or wallet
OnChainTransaction
object
2 properties
2 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…
TransactionStatus
string
Status of a payment transaction. | Status | Description | |--------|-------------| | CREATED | Initial lookup has been created | | PENDING | Quote has been cre…
XafAccountInfoBase
object
4 properties
4 required
PaymentZmwAccountInfo
PaymentXofAccountInfo
PaymentGtqAccountInfo
PaymentSgdAccountInfo
BdtAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
6 properties
2 required
ScaFactor
string
A Strong Customer Authentication factor. | Factor | Description | |--------|-------------| | SMSOTP | One-time code sent by SMS to the customer's verified phon…
TestWebhookRequest
CounterpartyInformation
object
Additional information about the counterparty, if available and relevant to the transaction and platform.
KesAccountInfoBase
object
3 properties
3 required
WebhookType
string
Type of webhook event in OBJECT.EVENT dot-notation. The part before the dot identifies the resource, the part after identifies the event. This lets consumers r…
PaymentSlvAccountInfo
CardTransactionWebhook
IncomingPaymentWebhook
VerificationStatus
string
Current status of the KYC/KYB verification
EurAccountInfoBase
object
3 properties
2 required
OutgoingPaymentWebhook
PaymentInstructions
object
3 properties
1 required
PaymentXafAccountInfo
BusinessInfoUpdate
object
Additional information for business entities
19 properties
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
Transaction
object
14 properties
7 required
UmaAddressDestination
BulkUploadWebhook
InrAccountInfoBase
object
Required fields depend on the selected paymentRails: - NEFT: accountNumber, ifsc, rail - RTGS: accountNumber, ifsc, rail - UPI: vpa
6 properties
1 required
GbpAccountInfo
Address
object
6 properties
3 required
OutgoingTransactionStatus
string
Status of an outgoing payment transaction. | Status | Description | |--------|-------------| | PENDING | Quote is pending confirmation | | PENDINGAUTHORIZATION…
Verification
object
6 properties
5 required
NgnAccountInfoBase
object
3 properties
3 required
PaymentMxnAccountInfo
EgpAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankName, iban - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
AedAccountInfo
CardFundingSourceChangeWebhook
UmaAddressTransactionDestination
ZarAccountInfoBase
object
3 properties
3 required
DkkAccountInfo
InvitationClaimedWebhook
PaymentTronWalletInfo
SwiftAccountInfo
Currency
object
4 properties
IdrAccountInfo
BusinessCustomerFields
object
4 properties
1 required
VerificationWebhook
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
PaymentNgnAccountInfo
SgdAccountInfoBase
object
4 properties
3 required
Card
object
16 properties
7 required
MwkAccountInfoBase
object
3 properties
3 required
CardForm
string
Physical form factor of the card. Only VIRTUAL is supported in v1; PHYSICAL will be added in a later release.
EntityType
string
Legal entity type of the business
CardSettlementSummary
object
2 properties
2 required
TransactionSourceType
string
Type of transaction source
PaymentGbpAccountInfo
PaymentDkkAccountInfo
SlvAccountInfo
CustomerType
string
Whether the customer is an individual or a business entity
BeneficialOwnerRole
string
Role of the beneficial owner within the business
CardMerchant
object
3 properties
1 required
Error400
object
4 properties
3 required
PaymentPhpAccountInfo
XofAccountInfo
BaseTransactionDestination
object
2 properties
1 required
TronWalletInfo
object
2 properties
2 required
CustomerOneOf
UsdAccountInfo
PaymentLightningInvoiceInfo
AccountQuoteSource
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
CurrencyAmount
object
2 properties
2 required
UmaAddressTransactionSource
PkrAccountInfo
ZarAccountInfo
SolanaWalletInfo
object
2 properties
2 required
ZmwAccountInfo
SparkWalletInfo
object
2 properties
2 required
CardState
string
Lifecycle state of a card. | State | Description | |-------|-------------| | PENDINGKYC | The cardholder has not yet completed KYC. Cards in this state cannot…
RwfAccountInfoBase
object
3 properties
3 required
PaymentEurAccountInfo
PaymentBdtAccountInfo
BaseDestination
object
1 property
1 required
PkrAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
5 properties
2 required
PaymentPolygonWalletInfo
MyrAccountInfo
SourceOfFundsCategory
string
A structured source-of-funds category for the business
HtgAccountInfo
MwkAccountInfo
ThbAccountInfo
PaymentCopAccountInfo
PhpAccountInfoBase
object
3 properties
3 required
Error401
object
4 properties
3 required
CadAccountInfo
CardTransactionStatus
string
Lifecycle status of a card transaction. | Status | Description | |--------|-------------| | AUTHORIZED | The auth has been approved and a hold placed on the fu…
PaymentRwfAccountInfo
TzsAccountInfoBase
object
3 properties
3 required
IndividualCustomer
CnyAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
PaymentKesAccountInfo
CustomerInfoFieldName
string
Name of a type of field containing info about a platform's customer or counterparty customer.
UmaInvitation
object
10 properties
5 required
PaymentSolanaWalletInfo
InternalAccount
object
10 properties
8 required
GtqAccountInfoBase
object
4 properties
4 required
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
BwpAccountInfoBase
object
3 properties
3 required
RwfAccountInfo
XafAccountInfo
ZmwAccountInfoBase
object
3 properties
3 required
AgentActionWebhook
TransactionDestinationOneOf
CnyAccountInfo
BaseWalletInfo
object
2 properties
2 required
PaymentMyrAccountInfo
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 Agent Operations 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
#Webhook
Where this information came from
This is an independent, third-party profile of Lightspark Webhooks 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.