Ctrl+K

Stage Settlement

post/trade-falcon/api/v2/admin/settlements

Request Body

endAt string <date-time>
End time
Example: 2024-12-31T23:59:59.000Z
memo string
Optional memo describing the settlement
Max length: <= 500 characters
Example: Monthly settlement for December 2024
tradingType string required
Type of trading for the settlement
Allowed values: FUNDED MARGIN
Example: FUNDED
trustOrg string required
Trust organization identifier
Min length: >= 1 characters
Example: BitGo Trust

202 Response

settlementId string <uuid>required
Unique identifier for the settlement
Example: 550e8400-e29b-41d4-a716-446655440000
status string required
Current status of the settlement
Allowed values: STAGING STAGED SETTLING SETTLED FAILED CANCELED CANCELING SETTLING_FAILED TRANSFERRED
Example: STAGED
updateTime string <date-time>required
Timestamp when the settlement was last updated (ISO 8601 format)
Example: 2024-12-01T10:00:00.000Z

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id