# ScripX Docs

> Developer and API documentation for ScripX, the exchange for RoDTEP and RoSCTL duty credit scrips. Sell a matured scrip for cash or cover a Bill of Entry with scrips instead of cash, at a firm price benchmarked to the Scrip Reference Rate, settled delivery-versus-payment on ICEGATE with a UTR on the payout. One API key.

## Docs

- [Money and price](https://docs.scripxhq.com/annexure/money-and-price.md): The three unit conventions of the ScripX API: money as integer paise, price as basis points of face value, and ISO 8601 IST timestamps, with worked examples for sell and buy sides.
- [Schemes](https://docs.scripxhq.com/annexure/schemes.md): The scheme enum of the ScripX API: RODTEP and ROSCTL duty credit scrip schemes, what each covers, who earns them, and the primary government sources for scheme rules.
- [Terminology](https://docs.scripxhq.com/annexure/terminology.md): Every term used in the ScripX API reference, defined for integrators: scrip, scroll, IEC, face value, balance, bps, all-in price, firm quote, price floor and ceiling, residual, cross and block deal, group netting, provenance, DvP, T+0, UTR, idempotency key, webhook signature and more, each with the…
- [Webhook events](https://docs.scripxhq.com/annexure/webhook-events.md): The ScripX webhook event catalog: order.matched, settlement.settled, settlement.failed, settlement.updated, credit.issued and payout.sent, with delivery headers, retry semantics and dedupe guidance.
- [Audit export](https://docs.scripxhq.com/api-reference/account/audit-export.md): Export your ScripX event log as a tamper-evident, hash-chained record: every event on your desk with a chain digest your auditor can verify offline.
- [Get your branding](https://docs.scripxhq.com/api-reference/account/branding.md): Read your ScripX white-label branding: the brand name, logo, support contact, accent colour and footer note that render on client-facing surfaces carrying your desk identity.
- [Set your branding](https://docs.scripxhq.com/api-reference/account/branding-set.md): Set your ScripX white-label branding: brand name, legal name, an https logo, support contact, a hex accent colour and a footer note, validated so a stored value can never become an XSS or SSRF vector.
- [Earnings](https://docs.scripxhq.com/api-reference/account/earnings.md): Read your ScripX desk economics: gross merchandise value, desk net earnings, and the payable balance you can withdraw.
- [Get a statement](https://docs.scripxhq.com/api-reference/account/statements.md): Fetch your ScripX bill for a period: itemised lines and the total, with mtd for the running month-to-date draft.
- [Usage](https://docs.scripxhq.com/api-reference/account/usage.md): Read your ScripX API key usage and quota as JSON: the same numbers as the X-RateLimit response headers, for dashboards and alerting.
- [Release a cross](https://docs.scripxhq.com/api-reference/cross/confirm.md): Release a funded ScripX cross: the gated terminal step that completes delivery versus payment, pays the seller and closes the deal.
- [Prepare a cross](https://docs.scripxhq.com/api-reference/cross/create.md): Prepare a block deal or intra-group transfer on the ScripX cross desk: a created cross never settles by itself, funding and release are separate explicit steps.
- [Get a cross](https://docs.scripxhq.com/api-reference/cross/get.md): Fetch one ScripX cross deal by id to read its lifecycle state: prepared, funded, settled.
- [List crosses](https://docs.scripxhq.com/api-reference/cross/list.md): List the block deals and intra-group transfers on your ScripX cross desk, cursor-paginated, with each deal in its current lifecycle state.
- [Price a cross](https://docs.scripxhq.com/api-reference/cross/quote.md): Price a ScripX cross before preparing it: the economics of a block deal or intra-group transfer, gross and net spread, platform fee, buyer pays and seller gets. Terms are defined in the terminology annexure.
- [Fund a cross](https://docs.scripxhq.com/api-reference/cross/settle.md): Fund a prepared ScripX cross: the explicit, gated money step that moves the buyer funds into settlement, distinct from preparing and from releasing the deal.
- [Authorize a firm](https://docs.scripxhq.com/api-reference/firms/authorize.md): Complete API-driven verification of a ScripX client firm with the one-time authorization code sent to the firm's registered email and mobile.
- [Register a firm](https://docs.scripxhq.com/api-reference/firms/create.md): Register a client firm on your ScripX desk: the first step of the firm lifecycle, followed by API-driven verification and authorization from your own UI.
- [Get one credit](https://docs.scripxhq.com/api-reference/firms/credit-detail.md): Fetch one credit of a connected ScripX client firm by scrip number: face, balance, expiry and status for a single duty credit.
- [List a firm's credits](https://docs.scripxhq.com/api-reference/firms/credits.md): List a connected ScripX client firm's duty credit inventory: scrip numbers, scheme, face and balance in paise, expiry and status, the input to the direct-quote loop.
- [Delete a firm](https://docs.scripxhq.com/api-reference/firms/delete.md): Offboard a client firm from your ScripX desk: the registration is removed and its connection released, while settled trades and the audit trail remain immutable.
- [Get a firm](https://docs.scripxhq.com/api-reference/firms/get.md): Fetch one client firm on your ScripX desk by IEC and read its live connection state.
- [List firms](https://docs.scripxhq.com/api-reference/firms/list.md): List every client firm registered on your ScripX desk with its live connection state, cursor-paginated.
- [Update a firm](https://docs.scripxhq.com/api-reference/firms/update.md): Update a ScripX client firm's registration details, name and contact email, without touching its connection state.
- [Verify a firm](https://docs.scripxhq.com/api-reference/firms/verify.md): API-driven verification of a client firm on ScripX: submit the firm's customs-account credentials under its mandate, then complete with the one-time authorization code sent to the firm.
- [Netting plan](https://docs.scripxhq.com/api-reference/group/net-plan.md): Compute the minimal intra-group transfer plan on ScripX: pass net positions per group company and scheme, get back the smallest set of internal transfers that squares the group.
- [Group positions](https://docs.scripxhq.com/api-reference/group/positions.md): Read your ScripX book aggregated by scheme and group company: the ready-made input for the intra-group netting plan.
- [API reference overview](https://docs.scripxhq.com/api-reference/introduction.md): Conventions shared by every ScripX API endpoint: one REST API across selling, buying, the cross desk, group netting and platform integration, with the base URL, X-ScripX-Key authentication, paise and bps units, cursor pagination, idempotency, rate-limit headers and error handling.
- [Mint a child key](https://docs.scripxhq.com/api-reference/keys/create.md): Mint a scoped ScripX child API key for a sub-account or app: scopes are always a subset of the parent key, and the raw key is shown exactly once.
- [List child keys](https://docs.scripxhq.com/api-reference/keys/list.md): List the child API keys minted under your ScripX key, masked, with label, scopes and status for each sub-account.
- [Revoke a child key](https://docs.scripxhq.com/api-reference/keys/revoke.md): Revoke one of your ScripX child API keys immediately: the hash stops matching on the next request, with no propagation delay.
- [Free status enquiry](https://docs.scripxhq.com/api-reference/public/enquiry.md): GET /public/enquiry/{kind} runs a free Bill of Entry, Shipping Bill or challan status check. Public, no API key, strictly rate-limited per IP, demo-first with an honest live mode.
- [Get the rate card](https://docs.scripxhq.com/api-reference/public/rate-card.md): GET /public/rates/card returns the daily SRR as a plain-text, shareable rate card for both schemes. Public, no API key, no markup, no secrets.
- [Get the SRR history](https://docs.scripxhq.com/api-reference/public/rate-history.md): GET /public/rates/{scheme}/history returns the daily Scrip Reference Rate series behind today number, up to 90 days, oldest to newest. Public, no API key.
- [Get the Scrip Reference Rate](https://docs.scripxhq.com/api-reference/public/rates.md): GET /public/rates returns today published Scrip Reference Rate (SRR) for both schemes with its methodology. Public, no API key, CDN-cacheable.
- [Market snapshot](https://docs.scripxhq.com/api-reference/trading/market.md): Read the ScripX market depth snapshot for a duty credit scrip scheme: aggregate supply on offer and duty demand, per scheme.
- [Live market stream (SSE)](https://docs.scripxhq.com/api-reference/trading/market-stream.md): Stream live ScripX market snapshots over Server-Sent Events: per-scheme market events at a chosen interval with automatic client reconnect semantics.
- [Place many orders](https://docs.scripxhq.com/api-reference/trading/orders-batch.md): Batch order placement on ScripX: submit up to 500 duty credit scrip orders in one call with partial success semantics and per-item results.
- [Place an order](https://docs.scripxhq.com/api-reference/trading/orders-create.md): Place a duty credit scrip sell or buy order on ScripX with a price floor in bps of face and safe retries via the Idempotency-Key header.
- [Get an order](https://docs.scripxhq.com/api-reference/trading/orders-get.md): Fetch one ScripX order by id to read its current status through matching and settlement.
- [List positions](https://docs.scripxhq.com/api-reference/trading/positions.md): List your ScripX orders and wallet in one cursor-paginated read: the reconciliation endpoint for your whole desk.
- [Get a firm quote](https://docs.scripxhq.com/api-reference/trading/quote.md): Get a firm ScripX quote for a duty credit scrip trade: price one credit by scrip number or a face amount to sell, or a duty requirement to buy, returning price in bps and one all-in paise amount.
- [List failed deliveries](https://docs.scripxhq.com/api-reference/webhooks/failures.md): List dead-lettered ScripX webhook deliveries: every delivery that exhausted retries or hit a permanent failure, ready for replay.
- [List webhooks](https://docs.scripxhq.com/api-reference/webhooks/list.md): List your registered ScripX webhooks, masked, together with the live event catalog.
- [Register a webhook](https://docs.scripxhq.com/api-reference/webhooks/register.md): Register a ScripX webhook endpoint and receive the HMAC signing secret exactly once, subscribing to one event or the full catalog.
- [Replay failed deliveries](https://docs.scripxhq.com/api-reference/webhooks/replay.md): Replay dead-lettered ScripX webhook deliveries after fixing your receiver: one delivery by id, or the whole dead-letter queue.
- [API terms](https://docs.scripxhq.com/api-terms.md): The ScripX API terms in plain language: acceptance, key attribution, fair use, environments, client mandates, order finality, data ownership, prohibited integrations and order of precedence.
- [Authentication](https://docs.scripxhq.com/authentication.md): Authenticate to the ScripX API with the X-ScripX-Key header: how keys are issued, the scope model, per-plan rate limits, and the exact X-RateLimit response headers on every call.
- [How to buy duty credit scrips](https://docs.scripxhq.com/concepts/buy-duty-credit-scrips.md): A guide for importers buying RoDTEP and RoSCTL duty credit scrips: how paying customs duty with scrips saves cash, how to size a requirement against a Bill of Entry, what to check before buying, and how transfer and utilisation work on ICEGATE.
- [Glossary of duty credit scrip terms](https://docs.scripxhq.com/concepts/glossary.md): Plain definitions of the terms used in duty credit scrip trading: RoDTEP, RoSCTL, e-scrip, scroll, IEC, ICEGATE, BCD, Bill of Entry, FOB, face value, discount, basis points, DvP, UTR, HSN 4907 and the ScripX API fields that carry them.
- [RoDTEP scheme explained](https://docs.scripxhq.com/concepts/rodtep-scheme.md): RoDTEP explained for exporters: what the Remission of Duties and Taxes on Exported Products scheme refunds, how rates are notified per HS code as a percentage of FOB, how a claim moves from shipping bill to scroll to e-scrip, and what the credit is worth.
- [RoSCTL scheme explained](https://docs.scripxhq.com/concepts/rosctl-scheme.md): RoSCTL explained for apparel and made-ups exporters: what the Rebate of State and Central Taxes and Levies covers, which HS chapters qualify, how RoSCTL differs from RoDTEP, and how the scrip is issued, transferred and sold.
- [Duty credit scrip price and discount rate explained](https://docs.scripxhq.com/concepts/scrip-price-discount.md): How duty credit scrip prices work: why scrips trade below face value, what the discount rate means, the drivers that move it (expiry, scheme, size, provenance, duty demand), how basis points convert to rupees, and where to read the live benchmark.
- [Scrip transfer on ICEGATE explained](https://docs.scripxhq.com/concepts/scrip-transfer-icegate.md): How duty credit scrip transfer works on ICEGATE: the e-scrip ledger, what a transfer moves, the once-only transfer rule, why validity does not reset, what the transferee must have in place, and how delivery versus payment removes the trust gap.
- [Scrip validity and expiry](https://docs.scripxhq.com/concepts/scrip-validity-expiry.md): How long a duty credit scrip stays valid: the one-year window from creation in the customs ledger, why transfer does not reset it, how expiry drives the discount, and how to manage a scrip book so nothing expires unsold.
- [How to sell RoDTEP scrips](https://docs.scripxhq.com/concepts/sell-rodtep-scrips.md): A step by step guide to selling RoDTEP and RoSCTL duty credit scrips: converting scroll to e-scrip, getting a firm price instead of a negotiated one, what a buyer checks, how transfer and payment are sequenced, and how to avoid the usual losses.
- [Core concepts](https://docs.scripxhq.com/core-concepts.md): The concepts every ScripX integration rests on: duty credit scrips, the Scrip Reference Rate (SRR), provenance screening, delivery-versus-payment settlement on ICEGATE with a UTR, and the GST-exempt HSN 4907 treatment of a scrip sale.
- [Environments and base URLs](https://docs.scripxhq.com/environments.md): How ScripX API environments behave: one host, the environment carried by the key prefix, a sandbox where the full trade lifecycle runs with simulated money, and production where settlement is real.
- [Errors](https://docs.scripxhq.com/errors.md): The ScripX API error contract: the flat opaque error body, the stable slug to branch on, the request_id correlation id on every response, every HTTP status the API returns, and how rate-limit and body-size errors behave.
- [FAQ](https://docs.scripxhq.com/faq.md): Frequently asked questions about the ScripX API: duty credit scrip trading, RoDTEP and RoSCTL prices in bps, paise amounts, settlement, sandbox keys, webhooks, block deals and white-labelling.
- [Broker: run a cross desk](https://docs.scripxhq.com/guides/broker-desk.md): The broker flow on ScripX: match your own exporters and importers inside your book with the cross desk, price a block deal, prepare it, fund it and release it as separate gated steps, net positions across a group, and read your desk earnings and payable.
- [Enterprise: net a multi-entity group](https://docs.scripxhq.com/guides/enterprise-group.md): The multi-entity flow on ScripX: read net scrip positions across every group company, compute the minimal set of internal transfers that squares the group, book each transfer as an intra-group cross, and take only the residual to market.
- [Exporter: sell a scrip for cash](https://docs.scripxhq.com/guides/exporter-sell.md): The sell-side flow for exporters on ScripX: connect a firm, list its sellable duty credits, take a firm quote per credit at the Scrip Reference Rate, place an order with a price floor, and get paid out with a UTR the same day.
- [Importer: cover duty with scrips](https://docs.scripxhq.com/guides/importer-buy.md): The buy-side flow for importers on ScripX: quote a duty requirement, receive a bundle of whole credits assembled to cover it, see the cash saving versus paying duty in full, and settle delivery-versus-payment so the cover applies against the Bill of Entry on ICEGATE.
- [Platform: embed ScripX](https://docs.scripxhq.com/guides/platform-embed.md): How a platform embeds ScripX for hundreds of client firms behind one integration: register and verify firms from your own UI, mint one scoped child key per client service, take a direct quote per credit, white-label the experience, and reconcile across the whole book with one audit trail.
- [Idempotency](https://docs.scripxhq.com/idempotency.md): Make writes safe to retry on the ScripX API: send an Idempotency-Key on order placement so a network blip or a 429 retry returns the original order instead of double-placing a trade.
- [Introduction](https://docs.scripxhq.com/introduction.md): One REST API for India's duty credit scrip market: quote a firm price, place the order, settle the same day against a bank UTR. Sell RoDTEP and RoSCTL scrips, cover customs duty below face value, run a broker desk, net a multi-entity group, or embed the whole flow in your own product.
- [Quick start](https://docs.scripxhq.com/quick-start.md): Go from an API key to a placed duty-credit-scrip order in five curl calls: read the market, take a firm quote, place an idempotent order, then track it to settlement.
- [Rate limits and quotas](https://docs.scripxhq.com/rate-limits.md): How the ScripX API meters requests: a per-minute sliding-window rate and a monthly call quota per key, the exact X-RateLimit response headers on every call, the public-surface per-IP limits, and how to back off correctly on a 429.
- [SDKs and tools](https://docs.scripxhq.com/sdks.md): Official ScripX API clients for Python and TypeScript: resource namespaces over the full /v1 surface, typed responses, an exception hierarchy, auto pagination, idempotent writes, and webhook verification. Plus the live OpenAPI spec for generating clients in any language.
- [Use with AI (MCP)](https://docs.scripxhq.com/use-with-ai.md): Drive the ScripX API docs from AI tools: plain-text endpoints for LLMs, per-page copy and open-in-assistant actions, and the machine-readable OpenAPI contract your agent can code against.
- [Webhooks](https://docs.scripxhq.com/webhooks.md): Signed ScripX webhook deliveries for order and settlement events: HMAC SHA-256 signature verification, the delivery headers, retry and dead-letter semantics, and replaying failed deliveries.
- [What is a duty credit scrip?](https://docs.scripxhq.com/what-is-a-scrip.md): Duty credit scrips explained: what RoDTEP and RoSCTL scrips are, how exporters earn them from a shipping bill claim, why they trade at a discount to face value, how long they stay valid, and how importers use them to pay basic customs duty.
- [Why integrate ScripX](https://docs.scripxhq.com/why-scripx.md): What the ScripX API gives you without building any of it: a firm price for an exact amount, a counterparty on the other side, delivery-versus-payment settlement with a UTR on the payout, API-driven firm onboarding, statements and a tamper-evident audit trail.

## OpenAPI Specs

- [openapi](https://docs.scripxhq.com/api-reference/openapi.json)