Orders API
9 endpoints · Status codes: 0=Created 1=Active 2=Scheduled 3=On Hold 4=Cancelled 5=Time Out 6=Success 7=Declined 8=Revoked 9=Pending
POST
/api/v01/orders/create
Create a new payment order. Requires a creditor identifier and sale amount with ticker.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| credit.item | string | no | Creditor user item ID (one of item/nuvo/acnt required) |
| credit.nuvo | string | no | Creditor nuvo number |
| credit.acnt | string | no | Creditor account item ID |
| credit.name | string | no | Creditor display name |
| sale.number | string | yes | Order total amount (positive decimal) |
| sale.ticker | string | yes | Currency/token ticker (e.g. 'INR', 'USDT') |
| meta.name | string | no | Order display name |
| meta.memo | string | no | Order memo / description |
| feat.form | string | no | Feature flag — form type |
| feat.sort | string | no | Feature flag — sort preference |
| feat.auth | string | no | Feature flag — auth mode |
| link.main | string | no | Main redirect URL |
| link.done | string | no | Success redirect URL |
| link.fail | string | no | Failure redirect URL |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| credit | object | no | { name, nuvo, item, acnt } |
| sale | object | no | { number, ticker } |
| sold | object | no | Amount collected so far { number, ticker } |
| status | number | no | Order status (0 = Created) |
| active | boolean | no | Whether the order is active |
| item | string | no | Order item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"credit": {
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"meta": {
"name": "Invoice #42",
"memo": "Monthly subscription"
}
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
201 Created
{
"data": {
"credit": {
"name": "Jane Doe",
"nuvo": "9123456789012345",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
"acnt": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"sold": {
"number": "0.000000",
"ticker": "INR"
},
"status": 0,
"active": true,
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order created.",
"stat": true,
"code": 201,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Creditor identifier required
{
"data": {},
"memo": "Creditor identifier required in data.credit: item, nuvo, or acnt.",
"stat": false,
"code": 404,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}400 — Missing sale.ticker
{
"data": {},
"memo": "sale.ticker is required.",
"stat": false,
"code": 400,
"time": 1700000000000,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/details
Fetch order details by item ID.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| credit | object | no | Creditor info { name, nuvo, item, acnt } |
| sale | object | no | { number, ticker } |
| sold | object | no | Collected so far { number, ticker } |
| status | number | no | Current status code |
| active | boolean | no | Whether the order is active |
| item | string | no | Order item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"credit": {
"name": "Jane Doe",
"nuvo": "9123456789012345",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
"acnt": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"sold": {
"number": "0.000000",
"ticker": "INR"
},
"status": 0,
"active": true,
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order found.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Order not found
{
"data": {},
"memo": "Order not found.",
"stat": false,
"code": 404,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/list
Paginated list of all orders, optionally filtered by status.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| index | number | no | Page index (default: 1) |
| items | number | no | Per page (default: 10, max: 100) |
| status | number | no | Filter by status code |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| meta | object | no | { index, items, count } |
| list | array | no | Array of order objects |
Request Payload
Request data
{
"data": {
"index": 1,
"items": 20,
"status": 0
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"meta": {
"index": 1,
"items": 20,
"count": 5
},
"list": [
{
"credit": {
"name": "Jane Doe",
"nuvo": "9123456789012345",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"sold": {
"number": "0.000000",
"ticker": "INR"
},
"status": 0,
"active": true,
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"created": 1700000000000,
"modified": 1700000000000
}
]
},
"memo": "Orders found.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/list/user
Paginated list of orders for a specific user.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| user.item | string | yes | User item ID |
| index | number | no | Page index (default: 1) |
| items | number | no | Per page (default: 10, max: 100) |
| status | number | no | Filter by status code |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| meta | object | no | { index, items, count } |
| list | array | no | Array of order objects |
Request Payload
Request data
{
"data": {
"user": {
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"index": 1,
"items": 20
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Jane Doe",
"nuvo": "9123456789012345",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"meta": {
"index": 1,
"items": 20,
"count": 3
},
"list": [
{
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"sold": {
"number": "0.000000",
"ticker": "INR"
},
"status": 0,
"active": true,
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"created": 1700000000000,
"modified": 1700000000000
}
]
},
"memo": "Orders found.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — User identifier required
{
"data": {},
"memo": "User identifier required: data.user.item.",
"stat": false,
"code": 404,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/balance/set
Credit or debit the collected amount on an order.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
| amount.number | string | yes | Positive decimal amount |
| amount.ticker | string | no | Currency/token ticker (optional) |
| mode | string | yes | 'credit' or 'debit' |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Order item ID |
| sale | object | no | Total order amount { number, ticker } |
| sold | object | no | Updated collected amount { number, ticker } |
| status | number | no | Current status code |
| active | boolean | no | Whether the order is active |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"amount": {
"number": "200.000000"
},
"mode": "credit"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"sale": {
"number": "500.000000",
"ticker": "INR"
},
"sold": {
"number": "200.000000",
"ticker": "INR"
},
"status": 0,
"active": true,
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order balance updated.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Exceeds order sale total
{
"data": {},
"memo": "Amount would exceed the order sale total.",
"stat": false,
"code": 409,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/status/set
Update order status. Follows transition rules — cannot set a lower status.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
| status | number | yes | New status code (0–9) |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Order item ID |
| status | number | no | Updated status code |
| active | boolean | no | Whether the order is active |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"status": 1
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"status": 1,
"active": true,
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order status updated.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Cannot set a lower status
{
"data": {},
"memo": "Cannot set a lower status.",
"stat": false,
"code": 409,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/cancel
Cancel an order (sets status to 4). Blocked on settled orders.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Order item ID |
| status | number | no | 4 (Cancelled) |
| active | boolean | no | Whether the order is active |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"status": 4,
"active": true,
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order cancelled.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Cannot cancel a settled order
{
"data": {},
"memo": "Cannot cancel a settled order.",
"stat": false,
"code": 409,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/decline
Decline an order (sets status to 7). Blocked on already-cancelled orders.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Order item ID |
| status | number | no | 7 (Declined) |
| active | boolean | no | Whether the order is active |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"status": 7,
"active": true,
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order declined.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Order is already cancelled
{
"data": {},
"memo": "Order is already cancelled.",
"stat": false,
"code": 409,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/orders/delete
Soft-delete an order (sets active to false).
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Order item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Order item ID |
| active | boolean | no | false after deletion |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"active": false,
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Order deleted.",
"stat": true,
"code": 200,
"time": 1700000000000,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Order is already inactive
{
"data": {},
"memo": "Order is already inactive.",
"stat": false,
"code": 409,
"time": 1700000000000,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}