API reference
Account
Your account and the sandbox faucet.
GET
/v1/meSession or account keyThe signed-in account, or { account: null }.
curl
curl https://dapp.railpay.app/v1/me \
-H "Authorization: Bearer $RAILPAY_KEY"GET
/v1/overviewSession or account keyBalance, pockets, agents with today's spend, today's in/out/blocked totals and faucet left. Amounts in base units (6 decimals).
Response
{ "balance": 721500000, "pockets": [ … ], "agents": [ … ], "today": { "in": …, "out": …, "blocked": 1 }, "faucet_left_today": 500000000 }curl
curl https://dapp.railpay.app/v1/overview \
-H "Authorization: Bearer $RAILPAY_KEY"GET
/v1/statusNoneSandbox mode and network.
Response
{ "mode": "sandbox", "network": "railpay-sandbox", "asset": "SUSD", "decimals": 6, "settlement": "not_live" }curl
curl https://dapp.railpay.app/v1/statusAPI keys
GET
/v1/keysSession or account keyActive keys (prefix, label, agent, created, last used). Secrets are never returned again.
curl
curl https://dapp.railpay.app/v1/keys \
-H "Authorization: Bearer $RAILPAY_KEY"POST
/v1/keysSession or account keyCreate an account key, or an agent key when agent_id is set. The secret is in the response once.
Body
{ "label": "Backend", "agent_id": "agt_… (optional)" }Response
{ "id": "key_…", "key": "rp_sk_…", "prefix": "rp_sk_…" }curl
curl -X POST https://dapp.railpay.app/v1/keys \
-H "Authorization: Bearer $RAILPAY_KEY" \
-H "Content-Type: application/json" \
-d '{ "label": "Backend", "agent_id": "agt_… (optional)" }'DELETE
/v1/keys/:idSession or account keyRevoke a key.
curl
curl -X DELETE https://dapp.railpay.app/v1/keys/<id> \
-H "Authorization: Bearer $RAILPAY_KEY"PATCH
/v1/meSession or account keyUpdate name, handle or kind.
Body
{ "name": "Acme Studio", "handle": "acme", "kind": "business" }curl
curl -X PATCH https://dapp.railpay.app/v1/me \
-H "Authorization: Bearer $RAILPAY_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Studio", "handle": "acme", "kind": "business" }'POST
/v1/faucetSession or account keyAdd 100 SUSD. Max 1,000 SUSD per account per UTC day.
curl
curl -X POST https://dapp.railpay.app/v1/faucet \
-H "Authorization: Bearer $RAILPAY_KEY"