For AI agents: visit https://developer.drivewealth.com/apis/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Web API FIX API

Guides API Reference Changelog

Web API FIX API API Status Login

API Reference

API Status Login

Guides API Reference Changelog

Getting Started

Introduction
Idempotent requests
Events via SQS
Errors
Enumerations

Authentication APIs

Auth
- Create Session Tokenpost
- Create Authentication Tokenpost

Core APIs

Users
Entities
Accounts
Instruments
Orders
Positions
- List Account Positionsget
Transactions
- Retrieve Account Transaction Summaryget
- List Account Transactionsget
Exchanges
Commission Schedules
- List Commission Schedulesget
Supported Countries
- List Supported Countriesget
Correspondent Reports
- Retrieve Correspondent Reportsget
Performance
- Retrieve Account Performanceget
Position Management

Account Management APIs

Violations
- List Account Violationsget
- Retrieve Account Violations Summaryget
Statements
Beneficiaries
Physical Documents

Money Movement APIs

Linked Bank Accounts
Virtual Bank Accounts
- Retrieve Account Virtual Bank Accountget
Deposits
Contribution Limits
- Retrieve contribution limitsget
Withdrawals
Withholding Defaults
- Retrieve withholding defaultsget
Asset Transfer
Settlements
Subscriptions

Market Data APIs

Quotes
- Retrieve Quote (referential feed)get
- Retrieve Quote (consolidated feed)get
Charts
- Retrieve Chartget
Depth of Book
- Retrieve Depth of Bookpost

Advisor APIs

Trade Allocations
Advisor Reports
Funds
Portfolios
AutoPilot

Events

Account Events
Allocation Events
Asset Transfer Events
Cancel Rebill Events
Corporate Actions
Deposit Events
Instrument Events
KYC Events
Linked Bank Account Events
Order Events
Position Events
Settlement Events
Statement Events
Transaction Events
User Events
Violation Events
Withdrawal Events
Document Events
Entity events
Settlements
Accounts
Violations
- Violations Createdwebhook
- Violations Removedwebhook
Deposits
- Deposit Createdwebhook
- Deposit Updatedwebhook
Withdrawals
- Withdrawals Createdwebhook
- Withdrawals Updatedwebhook
Positions
- Positions Updatedwebhook
Documents
- Documents Createdwebhook
Entity
- Entity Createdwebhook
- Entity Updatedwebhook
KYC
- KYC Createdwebhook
- KYC Updatedwebhook
Users
- User Createdwebhook
- User Updatedwebhook
Statements
Linked Bank Accounts
Instruments
Asset Transfer
Cancel Rebill
Orders
Transactions
- Transactions Createdwebhook
Auth
- Auth Token Createdwebhook
Trade Allocations
- Allocation List Acceptedwebhook
- Allocation List Completewebhook
Subscriptions
- Subscription Createdwebhook
- Subscription Updatedwebhook

Settlement Created

webhook

settlements.created

The settlement generation has started.

Payload

id

string

type

string

enum

Show Details

settlements.created

Identifies this as a settlement-created event.

Allowed:

object

string

enum

Show Details

SETTLEMENTS_REPORT

The payload object type: a settlements report.

Allowed:

timestamp

date-time

payload

object

Response

200

Event received

Updated 20 days ago

Settlement Approved

Did this page help you?

Loading…

Updated 20 days ago

Settlement Approved

Did this page help you?