List a connected firm's credit inventory (feeds the direct-quote loop)
Scrips & credits
List a firm's credits
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.
GET
List a connected firm's credit inventory (feeds the direct-quote loop)
The connected firm’s complete credit inventory, cursor-paginated. This is the data your platform displays in its own UI so a client sees every credit they hold: number, scheme, face, unused balance, validity and status. It carries no price, an inventory is not a quote; you quote each
scrip_no only when the client is ready to sell.
The loop your platform builds on it: list the firm’s credits → show them → quote a credit on demand → sell at ScripX’s price. Every row has an expiry_date and a sellable flag, so an expiry radar for your clients (idle, near-expiry credit worth selling now) is one sort away.
Request example
Response example
balance_paise is the unused balance (face minus what has been utilized against duty). status is one of issued, utilized, transferred, cancelled, expired. sellable is true exactly when the credit is issued with a positive balance, ready to quote and sell; surface it directly in your UI.
In sandbox, a firm with an empty book returns two deterministic simulated credits, so your inventory UI builds end to end before anything is live.
Errors
409 conflict, the firm is notconnectedyet (verify first).404 not_found, no such firm on your desk.
Next steps
- Quote a credit by
scrip_no, then place the order.
Authorizations
Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.
Path Parameters
Query Parameters
Required range:
x <= 500opaque offset from a prior response's next_cursor