Funding

Deposits, withdrawals, internal transfers, and settlement lines

Funding Domain

The Funding domain handles all money movement: deposits, withdrawals, internal transfers, and settlement lines.


Deposits

Deposits bring funds into your sub-account, either via crypto on-chain transactions or bank transfers.

Crypto Deposit Flow

1. Generate deposit address for instrument
2. User sends funds to address
3. Platform detects transaction
4. Wait for confirmations
5. Balance credited

Fiat Deposit Flow

1. Get platform bank details with reference code
2. User initiates bank transfer with reference
3. Bank processes transfer (1-3 business days)
4. Platform receives and matches by reference
5. Balance credited

Deposit Status

StatusDescription
STATUS_NEWDeposit declared, awaiting funds
STATUS_TO_CONFIRMTransaction detected, awaiting confirmations
STATUS_CONFIRMEDConfirmations reached
STATUS_IN_PROGRESSBeing processed
STATUS_EXECUTEDBalance credited
STATUS_FAILEDDeposit failed
STATUS_CANCELEDCancelled by user

Deposit Endpoints

EndpointMethodDescription
/depositsPOSTCreate deposit declaration
/deposits/by-sub-account/{subAccountId}GETList deposits
/deposits/by-sub-account/{subAccountId}/{id}GETDeposit details
/deposits/by-sub-account/{subAccountId}/{id}/cancelPOSTCancel pending deposit

Withdrawals

Withdrawals move funds out of your sub-account to external addresses (crypto) or bank accounts (fiat).

Crypto Withdrawal Flow

1. Whitelist destination address (may require approval period)
2. Initiate withdrawal
3. Confirm with MFA
4. Platform broadcasts transaction
5. Balance deducted

Fiat Withdrawal Flow

1. Register bank account (IBAN)
2. Initiate withdrawal
3. Confirm with MFA
4. Platform initiates transfer (1-3 business days)
5. Balance deducted

Address Whitelisting

Security measure requiring addresses to be pre-approved before withdrawals.

StatusCan Withdraw
STATUS_CREATEDNo
STATUS_CONFIRMEDNo
STATUS_PENDING_VERIFICATIONNo
STATUS_VERIFIEDYes
STATUS_WHITELISTED_IN_CUSTODIANYes

Cooling Period: New addresses may require 24-48 hours before becoming active.

Withdrawal Status

StatusDescription
STATUS_PENDING_USER_CONFIRMATIONAwaiting email code + MFA
STATUS_ACTIVEUser confirmed, processing
STATUS_TO_CONFIRMAwaiting internal confirmation
STATUS_PENDING_BOOKING_IN_CORE_BANKING_SYSTEMCore banking processing
STATUS_PENDING_EXECUTIONReady for execution
STATUS_ACCEPTEDAccepted, being sent
STATUS_EXECUTEDSuccessfully completed
STATUS_FAILEDWithdrawal failed
STATUS_CANCELEDCancelled by user
STATUS_REFUSEDRefused by compliance

Withdrawal Endpoints

EndpointMethodDescription
/withdrawalsPOSTCreate withdrawal
/withdrawals/initPOSTInitialize withdrawal (sends email code)
/withdrawals/confirmPOSTConfirm with email code + MFA
/withdrawals/unconfirmed/cancelPOSTCancel unconfirmed withdrawal
/withdrawals/by-sub-account/{subAccountId}GETList withdrawals
/withdrawals/by-sub-account/{subAccountId}/{id}GETWithdrawal details

External Address Endpoints

EndpointMethodDescription
/investors/addresses/externalGETList whitelisted addresses
/investors/addresses/externalPOSTCreate whitelisted address
/investors/addresses/external/{id}GETGet address details
/investors/addresses/external/{id}DELETERemove whitelisted address
/investors/addresses/external/initPOSTResend confirmation code
/investors/addresses/external/confirmPOSTConfirm whitelisting (code + MFA)
/investors/addresses/external/verifyPOSTInitiate address verification

Bank Account Endpoints

EndpointMethodDescription
/bank-accounts/minePOSTRegister bank account
/bank-accounts/mineGETList bank accounts
/bank-accounts/mine/{id}DELETERemove bank account

Transfers

Internal transfers move funds between sub-accounts within the same client account.

Transfer Endpoints

EndpointMethodDescription
/transfersPOSTInternal transfer
/transfers/by-sub-account/{subAccountId}GETTransfer history

Settlement Lines

Settlement lines are short-term lending facilities available to entitled PRIME platform clients. They allow you to trade using funds up to a predefined limit, with the obligation to settle the exposure within a defined time window.

Key Concepts

TermDescription
Settlement LineA limit assigned to a sub-account, denominated in a quotation currency
ExposureThe amount currently being used from the settlement line
OverdraftThe portion of exposure that must be settled within a defined window
Exposure CallA request to settle a specific amount in a specific instrument
SettlementThe action of covering exposure using available funds

How It Works

  1. Line Allocation: A settlement line is configured for your sub-account with a maximum limit in a quotation currency (e.g., USD, CHF)
  2. Trading: You can place trades even without sufficient balance, up to your settlement line limit
  3. Exposure Tracking: As trades execute, your exposure increases
  4. Notifications: PRIME sends daily email reports showing your outstanding positions
  5. Settlement: You deposit funds and settle the exposure, either manually or automatically

Settlement Line Endpoints

EndpointMethodDescription
/exposure-lines/by-sub-account/{subAccountId}GETGet settlement line for a sub-account
/exposure-lines/by-sub-account/{subAccountId}PUTUpdate automatic settlement flag

Exposure Call Endpoints

EndpointMethodDescription
/exposure-calls/by-sub-account/{subAccountId}GETList exposure calls
/exposure-calls/by-sub-account/{subAccountId}/settlePOSTSettle exposure

Data Models

ExposureLine

Represents the settlement line configuration for a sub-account.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "clientAccountId": "96e9c58d-f7fe-47b9-a33b-e898d5c01119",
  "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
  "quotationId": "20000000-2000-0000-0000-000000000000",
  "quantity": "100000.00",
  "automaticSettlement": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}
FieldTypeDescription
idUUIDUnique identifier
clientAccountIdUUIDParent client account
subAccountIdUUIDSub-account this line belongs to
quotationIdUUIDInstrument ID for valuation currency
quantitydecimalMaximum limit
automaticSettlementbooleanAuto-settle on deposit
createdAttimestampCreation time
updatedAttimestampLast update time

ExposureCall

Represents an outstanding amount that needs to be settled.

{
  "id": "call-uuid",
  "clientAccountId": "96e9c58d-f7fe-47b9-a33b-e898d5c01119",
  "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
  "instrumentId": "10000000-2000-0000-0000-000000000000",
  "demandQuantity": "2.50000000",
  "coverQuantity": "1.00000000",
  "status": "STATUS_OPENED",
  "createdAt": "2024-01-14T10:00:00Z",
  "updatedAt": "2024-01-15T08:00:00Z"
}
FieldTypeDescription
idUUIDUnique identifier
clientAccountIdUUIDParent client account
subAccountIdUUIDSub-account this call belongs to
instrumentIdUUIDInstrument to settle
demandQuantitydecimalTotal amount to cover
coverQuantitydecimalAmount already covered
statusenumSTATUS_OPENED or STATUS_CLOSED
createdAttimestampCreation time
updatedAttimestampLast update time

ExposureCall.Status

ValueDescription
STATUS_NONEUnspecified
STATUS_OPENEDPending settlement
STATUS_CLOSEDFully settled

WebSocket Topic

Real-time exposure updates are available via WebSocket.

Topic: {subAccountId}@exposures

Authentication: Required

Message Format:

{
  "e": "exposure",
  "t": "{subAccountId}@exposures",
  "d": {
    "i": "quotation-instrument-uuid",
    "o": "15000.50",
    "u": "25000.00",
    "l": "100000.00"
  }
}
FieldDescription
iQuotation instrument ID
oOverdraft (must settle)
uUtilized (total exposure)
lLimit (settlement line cap)

Balance Integration

Exposure information is also reflected in balance records:

Balance FieldDescription
exposureOverdraftAmount that must be settled
exposureReservedAmount reserved for pending settlements

Fees

Fee TypeDescription
Network FeeBlockchain transaction fee (crypto)
Platform FeeService fee (may apply)
Bank FeeWire transfer fee (fiat)

Fees are shown before confirmation and deducted from the withdrawal amount.


Related




  © 2025 Taurus SA. All rights reserved.