API reference
Every operation in v1, with a link to its generated page carrying the full request and response schema.
The pages linked below are generated from the machine-readable API specification. There is one page per operation, each carrying the full request and response schema, every parameter, and a request sample you can run. Where a generated page and a guide disagree, the specification is authoritative.
Every path here is relative to the base URL:
https://api.threecommabank.com/api/partner/v1Vault deposits
| Operation | Does | Reference |
|---|---|---|
POST/deposits | Debits a fiat account you control and buys vault shares. | Reference |
GET/deposits/{id} | Fetches one deposit and its current state. | Reference |
GET/deposits | Lists your vault deposits. | Reference |
Guide: Vault deposits and withdrawals.
Vault withdrawals
| Operation | Does | Reference |
|---|---|---|
POST/withdrawals | Sells vault shares and credits a fiat account you control. | Reference |
GET/withdrawals/{id} | Fetches one withdrawal and its current state. | Reference |
GET/withdrawals | Lists your vault withdrawals. | Reference |
Guide: Vault deposits and withdrawals.
tcbUSD mints
| Operation | Does | Reference |
|---|---|---|
POST/token-mints | Debits a fiat account you control and mints the same amount of tcbUSD, booked to a sub-account. | Reference |
GET/token-mints | Lists your tcbUSD mints, newest first, filterable by status. | Reference |
GET/token-mints/{id} | Fetches one mint and its current state. | Reference |
Guide: Tokenised deposits, step by step.
tcbUSD redemptions
| Operation | Does | Reference |
|---|---|---|
POST/token-redemptions | Burns tcbUSD booked to a sub-account and credits the same amount of fiat to an account you control. | Reference |
GET/token-redemptions | Lists your tcbUSD redemptions, newest first, filterable by status. | Reference |
GET/token-redemptions/{id} | Fetches one tcbUSD redemption and its current state. | Reference |
Guide: Tokenised deposits, step by step.
Vault subscriptions
| Operation | Does | Reference |
|---|---|---|
POST/share-subscriptions | Puts tcbUSD booked to a sub-account into the currency's vault and books the shares to the same sub-account. | Reference |
GET/share-subscriptions | Lists your vault subscriptions, newest first, filterable by status. | Reference |
GET/share-subscriptions/{id} | Fetches one subscription and its current state. | Reference |
Guide: Tokenised deposits, step by step.
Vault redemptions
| Operation | Does | Reference |
|---|---|---|
POST/share-redemptions | Redeems shares booked to a sub-account for tcbUSD, paid at once and booked to the same sub-account. | Reference |
GET/share-redemptions | Lists your instant vault redemptions, newest first, filterable by status. | Reference |
GET/share-redemptions/{id} | Fetches one instant redemption and its current state. | Reference |
Guide: Tokenised deposits, step by step.
Queued vault redemptions
| Operation | Does | Reference |
|---|---|---|
POST/share-redemption-requests | Places shares booked to a sub-account in the vault's redemption queue, to be paid in tcbUSD when the vault can. | Reference |
GET/share-redemption-requests | Lists your queued redemptions, newest first, filterable by status. | Reference |
GET/share-redemption-requests/{id} | Fetches one queued redemption, with its place in the queue and what has been paid. | Reference |
POST/share-redemption-requests/{id}/cancel | Takes a queued redemption out of the queue; anything already paid stays paid. | Reference |
Guide: Tokenised deposits, step by step.
Crypto deposits
| Operation | Does | Reference |
|---|---|---|
POST/crypto-deposit-addresses | Issues your static deposit address for one asset on one chain and the account arrivals are credited to. | Reference |
GET/crypto-deposits | Lists every recorded arrival at your deposit addresses, newest first. | Reference |
GET/crypto-deposits/{id} | Fetches one crypto deposit and its current state. | Reference |
Guide: Crypto deposits.
Conversions
| Operation | Does | Reference |
|---|---|---|
POST/conversions/quote | Quotes a conversion: the rate, the commission and what it would credit, held until it expires. Nothing is converted. | Reference |
POST/conversions | Converts one currency you hold into another. | Reference |
GET/conversions/{id} | Fetches one conversion and its current state. | Reference |
Guide: Conversions.
Positions
| Operation | Does | Reference |
|---|---|---|
GET/positions | Your position in one currency's vault: settled, reserved and available shares, in total and per sub-account. | Reference |
GET/positions/tokens | Your tcbUSD in one currency: held, reserved and available, in total and per sub-account, with the balance of the wallet that holds it. | Reference |
GET/positions/share-price-history | A vault's observed share price, day by day. | Reference |
Guide: Positions.
Vault sub-accounts
| Operation | Does | Reference |
|---|---|---|
POST/sub-accounts | Registers a named partition of your own vault position. | Reference |
GET/sub-accounts | Lists your sub-accounts, oldest first, with tcb:default leading. | Reference |
Guide: Positions.
Sub-clients
| Operation | Does | Reference |
|---|---|---|
POST/sub-clients | Registers an end customer under your root and reserves a MAIN account and IBAN per currency, inactive until the sub-client is verified. | Reference |
GET/sub-clients | Lists your sub-clients, paginated. | Reference |
GET/sub-clients/{id} | Fetches one sub-client, with its verification state and accounts. | Reference |
PATCH/sub-clients/{id} | Updates a sub-client's legal name, identity record, transfer caps or metadata. | Reference |
GET/sub-clients/{id}/identity | Reads back the identity record you supplied. | Reference |
POST/sub-clients/{id}/attestations | Appends an attestation of the due diligence you performed. | Reference |
GET/sub-clients/{id}/attestations | Lists a sub-client's attestation history. | Reference |
POST/sub-clients/{id}/currencies | Adds a currency, with its MAIN account and IBAN. | Reference |
POST/sub-clients/{id}/close | Closes a sub-client irreversibly and retires its IBANs. | Reference |
Guide: Sub-clients.
Accounts
| Operation | Does | Reference |
|---|---|---|
GET/accounts | Lists accounts under you or a sub-client, filtered by currency, role or status. | Reference |
GET/accounts/{id} | Fetches one account, with its balance and IBAN. | Reference |
POST/accounts | Opens the owner's account in a currency, or returns the one it already holds. | Reference |
POST/accounts/{id}/iban | Returns an account's IBAN, issuing one only if it has none. | Reference |
POST/accounts/{id}/close | Closes an empty account with no open SUBs beneath it. | Reference |
Guide: Accounts.
Transfers
| Operation | Does | Reference |
|---|---|---|
POST/transfers | Moves fiat instantly between two accounts inside your own tree. | Reference |
GET/transfers | Lists transfers touching the acting node, paginated and date-filterable. | Reference |
GET/transfers/{id} | Fetches one transfer. | Reference |
Guide: Accounts.
Destinations
| Operation | Does | Reference |
|---|---|---|
POST/beneficiaries | Registers a payout destination — the payee and its bank account or wallet in one call. Never usable at registration. | Reference |
GET/beneficiaries | Lists your destinations, filterable by lifecycle state. | Reference |
GET/beneficiaries/{id} | Fetches one destination and whether a payout may name it right now. | Reference |
DELETE/beneficiaries/{id} | Removes a destination from use; the record stays readable. | Reference |
Guide: Destinations.
Payouts
| Operation | Does | Reference |
|---|---|---|
POST/payouts/quote | Quotes a payout: its Sending fee and total, held until it expires. Nothing is charged. | Reference |
POST/payouts | Pays a registered destination from a fiat account you control. | Reference |
GET/payouts/{id} | Fetches one payout and its current state. | Reference |
Guide: Payouts.
Settlements
| Operation | Does | Reference |
|---|---|---|
POST/settlements | Settles fiat instantly to another client of the bank. | Reference |
GET/settlements | Lists settlements you are a party to, newest first. | Reference |
GET/settlements/{id} | Fetches one settlement. | Reference |
POST/settlements/{id}/return-request | Asks the receiver to return a settlement. | Reference |
Guide: Settlements.
Network
| Operation | Does | Reference |
|---|---|---|
GET/network/profile | Reads your network profile: handle, trading names and receive policy. | Reference |
PUT/network/profile | Creates or amends your network profile. | Reference |
GET/network/resolve | Resolves a handle or a TCB IBAN to a member, in its verified legal name, before you pay. | Reference |
GET/network/search | Searches the member directory. | Reference |
GET/network/connections | Lists the members allowed to pay you when you accept connected senders only. | Reference |
POST/network/connections | Allows a member to pay you. | Reference |
DELETE/network/connections/{memberClientAccountId} | Stops allowing a member to pay you. | Reference |
Guide: Settlements.
Settlement requests
| Operation | Does | Reference |
|---|---|---|
POST/settlement-requests | Asks another member to pay you. | Reference |
GET/settlement-requests | Lists settlement requests you raised or received. | Reference |
GET/settlement-requests/{id} | Fetches one settlement request. | Reference |
POST/settlement-requests/{id}/approve | Pays a request made of you. | Reference |
POST/settlement-requests/{id}/decline | Refuses a request made of you. | Reference |
POST/settlement-requests/{id}/cancel | Withdraws a request you raised, while it is still open. | Reference |
Guide: Settlements.
Settlement holds
| Operation | Does | Reference |
|---|---|---|
POST/settlement-holds | Reserves funds against a member. | Reference |
GET/settlement-holds | Lists your settlement holds. | Reference |
GET/settlement-holds/{id} | Fetches one hold. | Reference |
POST/settlement-holds/{id}/release | Settles a hold to the member it was reserved against. | Reference |
POST/settlement-holds/{id}/cancel | Gives the reserve back. | Reference |
Guide: Settlements.
Settlement returns
| Operation | Does | Reference |
|---|---|---|
GET/settlement-returns | Lists return requests you raised or received. | Reference |
GET/settlement-returns/{id} | Fetches one return request. | Reference |
POST/settlement-returns/{id}/accept | Returns the money. | Reference |
POST/settlement-returns/{id}/decline | Declines to return it. | Reference |
POST/settlement-returns/{id}/cancel | Withdraws a return request you raised. | Reference |
Guide: Settlements.
Netting
| Operation | Does | Reference |
|---|---|---|
POST/netting/agreements | Proposes to net with a member. | Reference |
GET/netting/agreements | Lists your netting agreements. | Reference |
GET/netting/agreements/{id} | Fetches one agreement, with the open position as you read it. | Reference |
POST/netting/agreements/{id}/accept | Accepts a proposed agreement, naming your account under it. | Reference |
POST/netting/agreements/{id}/decline | Declines a proposed agreement. | Reference |
POST/netting/agreements/{id}/end | Ends an agreement. | Reference |
POST/netting/agreements/{id}/obligations | Records an amount you owe the other member under the agreement. | Reference |
GET/netting/agreements/{id}/obligations | Lists obligations under an agreement, newest first. | Reference |
GET/netting/obligations/{id} | Fetches one obligation. | Reference |
POST/netting/obligations/{id}/withdraw | Withdraws an open obligation you owe, releasing its reserve. | Reference |
POST/netting/agreements/{id}/cut | Offsets every open obligation both ways and settles the net. | Reference |
GET/netting/agreements/{id}/cuts | Lists past cuts of an agreement, newest first. | Reference |
Guide: Settlements.
Statements
| Operation | Does | Reference |
|---|---|---|
GET/statements | Lists statements, or issues and returns the one for a month you name. | Reference |
GET/statements/{id} | Fetches one statement, as JSON or CSV. | Reference |
Guide: Statements.
Webhooks
| Operation | Does | Reference |
|---|---|---|
POST/webhooks | Registers an endpoint for a chosen subset of the event catalogue, returning the signing secret once. | Reference |
GET/webhooks | Lists your registered endpoints. | Reference |
GET/webhooks/{id} | Fetches one endpoint, with a preview of its secret rather than the secret. | Reference |
DELETE/webhooks/{id} | Disables an endpoint. | Reference |
POST/webhooks/{id}/rotate-secret | Issues a new signing secret; both sign during the overlap window. | Reference |
Guide: Webhooks.
Identity
| Operation | Does | Reference |
|---|---|---|
GET/me | Identifies the principal your key authenticates as, and reports its scopes, environment tag and key prefix. | Reference |
The specification itself
openapi.partner.v1.json is the same contract in machine-readable form, for code generators and API tooling. It carries the disclosure in its description, as every response and every page here does.
Conventions
The rules that hold across every operation above.
Errors
Every code any of them can return.