Ask another network member to pay you
An ASK. It holds nothing, reserves nothing and moves nothing — the payer decides. Name the account you want credited and exactly one of toHandle, toIban or toClientAccountId. Cross-tree only: a movement inside your own tree is POST /transfers.
An ASK. It holds nothing, reserves nothing and moves nothing — the payer decides. Name the account you want credited and exactly one of toHandle, toIban or toClientAccountId. Cross-tree only: a movement inside your own tree is POST /transfers.
Authorization
bearer In: header
Header Parameters
Your own key for this request, 1-100 characters. Required, here or as the idempotencyKey body field; sending both is allowed only if they match. Replaying a key returns the first result without executing anything a second time, and sets replayed to true where the response carries that field. Sending the same key with different parameters is refused with 409 IDEMPOTENCY_KEY_REUSED — use a new key for a different request. While the first call is still running, a second call with the same key answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS. The key is remembered permanently: it is recorded against the movement it created, so a replay years later still resolves to that one movement.
Act on behalf of one of your sub-clients. The value is that sub-client id, and the request then reads and writes that sub-client's own accounts and registry rows rather than yours. Omit it to act as yourself. A route that does not accept the header refuses it with 400 ON_BEHALF_OF_NOT_ALLOWED_HERE rather than ignoring it — that includes every vault route (deposits, withdrawals, conversions, sub-accounts, positions), the webhook registry, and POST /sub-clients, since a sub-client never has sub-clients of its own. An id that is not one of your sub-clients answers 404 ON_BEHALF_OF_NOT_FOUND; a closed one answers 409 ON_BEHALF_OF_SUB_CLIENT_CLOSED; and a key restricted to a subset of your sub-clients answers 403 ON_BEHALF_OF_NOT_ALLOWED_FOR_KEY for any node outside it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
An ask: the amount you want another member to pay you, the account you want credited, and the reference the settlement will carry.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/partner/v1/settlement-requests" \ -H "Content-Type: application/json" \ -d '{ "amount": "1500.00", "currency": "USD", "dueBy": "2026-10-01T12:00:00.000Z", "endToEndId": "ACME-INV-2026-0042", "fromAccountId": "7e2a0c53-4d81-49b6-8f37-1a5c9e0b2d74", "idempotencyKey": "acme-req-2026-09-08-0001", "remittance": { "invoice": "INV-2026-0042" }, "toClientAccountId": "246f8056-fc27-4e06-a589-0866d9cbffbd", "toHandle": "acme-treasury", "toIban": "BH00TCB00000000000001" }'{ "data": { "amount": "1500.00", "createdAt": "2026-09-08T10:15:30.000Z", "currency": "USD", "decidedAt": null, "declineReason": null, "direction": "INBOUND", "disclosure": { "items": [ "ENVIRONMENT_IS_TESTNET: The environment is a testnet (Arbitrum Sepolia). No mainnet deployment exists.", "YIELD_IS_SIMULATED: The vault rate is set administratively and the interest it produces is minted as fresh underlying, not earned. It does not represent a return generated by deployed capital.", "FIAT_RAILS_ARE_MOCKED: No real fiat movement occurs. Balances are ledger entries against a sandbox provider.", "CONVERSION_RATES_ARE_MARKET_QUOTED_OR_REFUSED: A conversion is priced only by an external venue that quotes independently of TCB. When no such venue can price the pair, the conversion is refused rather than priced from an internal table. Read rate.pricingModel on every conversion: MARKET is a venue quote; any other value is not a market rate and must not be presented as one.", "CONTRACTS_ARE_UNAUDITED: No audit has been performed. Mainnet is gated on a two-firm audit that has not been commissioned.", "CUSTODY_IS_TCB_SUBACCOUNT: Everything held for the client — its vault shares, and the tcbUSD it holds between the steps of the tokenised deposit chain — is held in TCB custody, in the one TCB wallet assigned to the client. The client holds no keys and moves those tokens only through this API; each sub-account's shares and tcbUSD are book entries against what that wallet holds.", "INTEGRATION_AGREEMENT_ONLY: Fees as published on the rate card; no yield share, no return commitment." ], "summary": "This is a pilot integration on a testnet. Nothing in this system earns anything: the yield is simulated and the fiat rails are mocked.", "version": "2026-10-27" }, "dueBy": "2026-10-01T12:00:00.000Z", "endToEndId": "ACME-INV-2026-0042", "id": "sreq_3f8c1d2a5e6b7049a1b2c3d4e5f60718", "networkLabel": "CommaNet", "payer": { "accountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "clientAccountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "legalName": "Acme Trading Ltd" }, "pendingApprovalRequestId": null, "rail": "SETTLEMENT", "remittance": { "invoice": "INV-2026-0042" }, "replayed": false, "requester": { "accountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "clientAccountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "legalName": "Acme Trading Ltd" }, "settlementId": null, "status": "OPEN", "updatedAt": "2026-09-08T10:15:30.000Z" }, "success": true, "timestamp": "2026-09-02T10:15:30.000Z"}List settlement requests GET
Requests the ACTING node raised or was asked for, newest first. A request past its due-by date is marked EXPIRED as this page is read — that is the only thing that expires it.
Fetch one settlement request by its sreq_ id GET
Both parties read the same request, with direction reported for YOU. One you are not a party to answers 404 — never 403, which would confirm it exists.