Skip to main content
Each route on this page takes a capital provider credential: an API key with the route’s scope, or a signed-in account session of a member with the route’s role. A route with a JSON body takes network in the body, and a GET or DELETE route takes it in the query string. Every route serves the four network keys, except nonce-accounts, which serves only svm-mainnet and svm-devnet. A route names a capital provider by its id, the same capitalProvider.id that pairs, quotes, and batch orders carry: the stablecoin delegate ID on Ethereum, the capital provider’s wallet on Solana. A capital provider of another organization answers 403 with code FORBIDDEN, and an ID that is not a batch order capital provider on the network, such as a delegate whose batch orders were never turned on, answers 404 with code NOT_FOUND. An orderId is a lowercase UUID. A list’s cursor continues only the listing it was issued for: the same route, network, and filters, with a credential of your organization; another limit is fine. The public order reads, GET /v1/batch-orders/{orderId} and GET /v1/batch-orders?user=, return the same order for every caller, as Batch orders describes.

Your capital providers

GET /v1/batch-orders/capital-providers?network= lists your organization’s capital providers whose batch orders are on for the network. The response holds the network, the batch, the capitalProviders, and nextCursor. It takes batchId, limit, and cursor as batch info does, but neither route continues the other’s cursor. An empty list means your organization has no such capital provider on the network, as Get set up explains. Each entry has:

Capacity

PUT /v1/batch-orders/capital-providers/{capitalProviderId}/capacity sets the posted total of one token for one batch, and returns the token’s capacity. It needs cp:operate.
Response
  • batchId names the batch by its New York release date, from 2000-01-01 through 9999-12-29; a date outside that range is rejected with 422 and INVALID_BODY. A batch takes capacity until its cut-off whatever its intakeOpen, which is about users’ orders only.
  • token is the token’s address: on Ethereum, the capital provider’s stablecoin or any RWA the network lists, including one its delegate does not whitelist, which is posted as inactive; on Solana, a mint of one of its pairs. Any other token is rejected with 422 and INVALID_BODY, with details.field token, and on Ethereum a capital provider the network no longer lists with 422 and UNSUPPORTED_ROUTE.
  • posted is the absolute total in whole tokens, not an increment: a decimal string from 0, with at most 6 decimal places and no more than the token’s decimals. Any other value is rejected with 422 and INVALID_BODY, with details.field posted. You can post for the current batch until its 4:30 PM cut-off and for later batches in advance.
  • Accepted orders reserve capacity as they arrive. A total below what they already reserve is rejected with 409 and CAPACITY_BELOW_RESERVED, whose details.reserved is the floor, in whole tokens.
  • On evm-mainnet, a nonzero RWA total requires the capital provider’s custody to pass the RWA’s whitelist adapter; otherwise, or when the RWA has no adapter, the update is rejected with 409 and CUSTODY_NOT_WHITELISTED. A zero total skips the check, so unreserved capacity can always be withdrawn.
  • An update after the cut-off is rejected with INTAKE_CLOSED, and one for a capital provider whose batch orders are off with BATCH_ORDERS_DISABLED.
The body is limited to 256 bytes.

Operator

PUT /v1/batch-orders/capital-providers/{capitalProviderId}/operator with {"network": "...", "operator": "..."} selects or replaces the wallet that executes the capital provider’s orders: an address on Ethereum, a base58 key on Solana. DELETE on the same path, with network in the query string, clears it. Both return 204 and need cp:admin, which only an admin holds and only an admin can grant to a key.
  • A capital provider without an operator takes no new orders, and preparation answers OPERATOR_NOT_SELECTED.
  • Orders are signed for the operator that was current when they were prepared. After a change, a new order signed for the old operator is rejected with OPERATOR_MISMATCH, whose details.expected names the new one, or is null after the operator is cleared. Orders accepted before the change keep their signed operator, which the order list shows and the requirements show beside the current one.
  • Clearing an operator leaves the capital provider’s capacity stored. Repeating it changes nothing.
The body is limited to 128 bytes.

Funding requirements

GET /v1/batch-orders/batches/{batchId}/requirements?network= totals the accepted, uncanceled orders of one batch by capital provider, signed operator, and token, so you can fund your custody before the release. batchId is the release date in YYYY-MM-DD form. It needs read, filters by operator and capitalProvider, and pages with limit and cursor. The totals are what you pay out, never netted against what you receive.

Released payloads

GET /v1/batch-orders/payloads?network= returns your organization’s orders once their batch is released at 5:00 PM, with what the operator executes. Without batchId or orderId, it returns the latest released batch. It needs read, filters by operator, including your earlier operators, and capitalProvider, and pages with limit and cursor. Canceled orders never appear. Each payload has runtime, orderId, batchId, acceptedAt, and releasedAt, and:
  • on Ethereum, authorization, the complete signed authorization: chainId, verifyingContract, user, operator, receiver, inputs, with their signed amounts in base units, unordered (always true), nonce, deadline, and the user’s signature;
  • on Solana, the user-signed transaction in base64 with the operator’s signature slot empty, the operator, nonceAccount, nonceValue, and deadline.
Payloads are the only responses that return signatures and executable authorizations, and only to the organization whose capital provider accepted the order. A payload grants no execution rights: only its signed operator can execute it.

Reports

POST /v1/batch-orders/{orderId}/reports records your report of one released order’s outcome. It needs cp:operate.
status says what happened to the order: An order you never report is treated as a failure report, and a verified execution makes the order completed whatever you report.
  • reason is required. transactionId is optional: the transaction hash on Ethereum or the signature on Solana. It points Multiliquid’s search for the execution but is not itself evidence of it.
  • Reports are accepted from the batch’s release, at or just after 5:00 PM (the payloads’ releasedAt), until its 5:30 PM close, and never for canceled orders. A report outside that window is rejected with 409 and REPORTING_CLOSED.
  • Each accepted report adds a revision and returns 201 with it: revision, authorUserId, receivedAt, status, reason, and transactionId. The latest revision counts. A report filed with an organization key has a null authorUserId.
A report is a claim. Multiliquid assigns each order’s state from verified on-chain execution: an order whose reported success it has not verified is underReview, as Batch orders describes. The body is limited to 4 KiB.

Your orders

GET /v1/batch-orders/capital-providers/orders?network= lists the uncanceled orders of your organization’s capital providers, newest first. Each entry has the order, as GET /v1/batch-orders/{orderId} returns it, with the operator it signed, the only wallet that can execute it, and its signed deadline in Unix seconds. It needs read, filters by user and capitalProvider, and pages with limit and cursor. GET /v1/batch-orders/{orderId}/attempts?network= returns up to 100 of an order’s Ethereum execution attempts, newest first, each with transactionId, blockNumber, observedAt, and state: confirmed, reverted, unresolved, or orphaned when a chain reorganization removed it. Solana orders return an empty list. It reads only your organization’s uncanceled orders.

Solana nonce accounts

POST /v1/batch-orders/nonce-accounts with {"network": "svm-mainnet", "address": "<base58>"} adds a durable nonce account to an operator’s pool, and returns 200 with its address, operator, and nonceValue. It needs cp:operate. The account must be an initialized nonce account whose authority is an operator that your organization selected on the network:
  • an address that is not an initialized nonce account answers 422 with INVALID_BODY;
  • an account whose authority is not one of your selected operators answers 403 with FORBIDDEN;
  • an account that holds another operator’s order answers 409 with CONFLICT.
Each prepared Solana order uses one idle account from its operator’s pool, and preparation answers NONCE_ACCOUNT_UNAVAILABLE when the pool has none. Each open order holds its account until it executes, expires, or is canceled, so the pool’s size limits the operator’s open orders. You never advance the nonces: once a released order’s deadline passes with its nonce unchanged, Multiliquid records the order as not executed and returns the account to the pool. The body is limited to 128 bytes.

Errors

Errors gives each code’s remedy.