Start here
What is a scrip?
New to duty credit scrips? The concept, the schemes (RoDTEP, RoSCTL), and why exporters sell them and importers buy them.
Quick start
Market snapshot to firm quote to a placed order in five curl calls.
Authentication
The
X-ScripX-Key header, scopes, plans, and the exact rate limit headers on every response.Webhooks
Signed event deliveries for order and settlement milestones, with retries, dead-letters and replay.
Errors
The flat error body, every status code, and the stable
code values to branch on.SDKs and tools
Thin Python and TypeScript clients, webhook verification helpers, and the live OpenAPI spec.
The lifecycle at a glance
1
Onboard your firms
ScripX issues your desk an API key. Register each client firm, exporters and importers alike, then verify it from your own UI: the firm’s customs-account credentials under its mandate, completed with a one-time authorization code. Mint scoped child keys for sub-accounts yourself.
2
Quote
Read the market snapshot or the live stream, then take a firm two-sided quote for an exact amount.
3
Order
Place the order at the quoted price with an
Idempotency-Key, or batch up to 500. Desks with the advanced cross desk enabled can also book deals inside their own book.4
Track and get paid
Poll positions or register a webhook for
order.matched, settlement.settled and payout.sent. Reconcile with statements and the tamper-evident audit export.Base URLs
scripx_live_… is production, scripx_test_… is the sandbox where the full lifecycle runs with simulated money and nothing real ever moves. Build your whole UI there first; see Environments. The machine-readable contract is public at GET /v1/openapi.json.
Money, price and time
Three conventions hold everywhere: money is integer paise, price is bps of face value, timestamps are ISO 8601 (IST). The Money and price annexure has worked examples.Need help?
Write to support
Support is first-party, no ticket maze. Include your key prefix (never the full key) and, for a specific call, the response body you received.