e-Stamp Order Creation

● Live

Create an e-Stamp order using the generic orders API with an e-Stamp serviceCode.

POST/v1/orders

● Live

Create an order (generic - works for any entitled serviceCode, including e-Stamp)

Generic order-creation endpoint. For e-Stamp, pass an e-Stamp `serviceCode` (from GET /v1/services) and put instrument/party/value details in the free-form `details` object. There is no e-Stamp-specific request/response contract yet (no first-class `state`, `article`, `parties[]` fields) - the shape of `details` for e-Stamp is not finalized upstream.

Required scope: orders.create

Parameters

Name	Type	Required	Description
Authorization	header	Yes	Bearer <api-key> (e.g. sk_test_... in sandbox, sk_live_... in production). The x-api-key header is also accepted.
Idempotency-Key	header	No	Optional idempotency key.
externalOrderId	string	Yes	Your own reference for this order.
externalCustomerId	string	Yes	Your own reference for the customer.
serviceCode	string	Yes	The entitled service to order (e.g. an estamp.* code).
details	object	No	Free-form service-specific payload (e-Stamp field shape is not finalized).

Example request

{
  "externalOrderId": "ord_ext_123",
  "externalCustomerId": "cust_ext_456",
  "serviceCode": "estamp.instrument.rent_agreement",
  "details": {
    "state": "MH",
    "stampValue": 500,
    "note": "Shape not finalized - illustrative only"
  }
}

GET/v1/orders/:id

● Live

Get an order

Fetch an order by its B2B-assigned id.

Required scope: orders.read

Parameters

Name	Type	Required	Description
Authorization	header	Yes	Bearer <api-key> (e.g. sk_test_... in sandbox, sk_live_... in production). The x-api-key header is also accepted.

GET/v1/orders/:id/status

● Live

Get order status

Poll the current lifecycle status of an order.

Required scope: orders.read

Parameters

Name	Type	Required	Description
Authorization	header	Yes	Bearer <api-key> (e.g. sk_test_... in sandbox, sk_live_... in production). The x-api-key header is also accepted.