Effects
Subscriptions that react to ledger signals — deliver the event payload to a webhook endpoint or a bridge. Supports all ledger signals (`balance-received`, `intent-updated`, `wallet-created`, `signer-updated`, and 50+ more) with optional dot-path filters for fine-grained targeting.
List effects
Authorization
BearerAuth LedgerHeader Access token obtained from POST /oauth/token
In: header
Handle of the target ledger (e.g. demo-co)
In: header
Query Parameters
Maximum records to return
25value <= 100Records to skip
0Response Body
application/json
curl -X GET "https://demo-co.ldg-stg.one/api/v2/effects"{
"data": [
{
"handle": "notify-payment-received",
"signal": "anchor-created",
"filter": {
"wallet.data.handle": "main@comercio-ejemplo.com.co"
},
"action": {
"schema": "webhook",
"endpoint": "https://comercio-ejemplo.com.co/api/webhooks/minka"
}
}
],
"meta": {
"total": 4,
"limit": 25,
"offset": 0
}
}Create webhook subscription
Authorization
BearerAuth LedgerHeader Access token obtained from POST /oauth/token
In: header
Handle of the target ledger (e.g. demo-co)
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://demo-co.ldg-stg.one/api/v2/effects" \ -H "Content-Type: application/json" \ -d '{ "data": { "handle": "notify-balance-received-comercio", "signal": "balance-received", "filter": { "wallet.data.handle": "main@comercio-ejemplo.com.co" }, "action": { "schema": "webhook", "endpoint": "https://comercio-ejemplo.com.co/api/webhooks/minka" } } }'{
"data": {
"handle": "notify-payment-received",
"signal": "anchor-created",
"filter": {
"wallet.data.handle": "main@comercio-ejemplo.com.co"
},
"action": {
"schema": "webhook",
"endpoint": "https://comercio-ejemplo.com.co/api/webhooks/minka"
}
}
}{
"error": {
"code": "schema-validation-failed",
"message": "Required field 'schema' is missing from data"
}
}Get effect
Authorization
BearerAuth LedgerHeader Access token obtained from POST /oauth/token
In: header
Handle of the target ledger (e.g. demo-co)
In: header
Path Parameters
Record handle
Response Body
application/json
application/json
curl -X GET "https://demo-co.ldg-stg.one/api/v2/effects/pay-20260608-001"{
"data": {
"handle": "notify-payment-received",
"signal": "anchor-created",
"filter": {
"wallet.data.handle": "main@comercio-ejemplo.com.co"
},
"action": {
"schema": "webhook",
"endpoint": "https://comercio-ejemplo.com.co/api/webhooks/minka"
}
}
}{
"error": {
"code": "not-found",
"message": "Wallet not found"
}
}Anchors
External payment identifiers mapped to wallets — EMVCo QR v1.4 codes (`emvco-v14-co`) and Bre-B Llaves (`alias`) including `mailto:`, `tel:`, `nidn:`, `merchid:`, and dynamic `key:` types.
Schemas
JSON Schema record-type definitions that govern the allowed `custom` fields on wallets, anchors, intents, signers, and policies.